Technical reference

This section contains technical details on pysisso. It is meant to be used as a reference for checking out specific. In particular, the API of the main objects are presented here. The complete API can be found in API.

API of the most relevant objects

To be added

class pysisso.sklearn.SISSORegressor(ntask=1, task_weighting=1, desc_dim=2, restart=False, rung=2, opset='(+)(-)', maxcomplexity=10, dimclass=None, maxfval_lb=0.001, maxfval_ub=100000.0, subs_sis=20, method='L0', L1L0_size4L0=1, fit_intercept=True, metric='RMSE', nm_output=100, isconvex=None, width=None, nvf=None, vfsize=None, vf2sf=None, npf_must=None, L1_max_iter=None, L1_tole=None, L1_dens=None, L1_nlambda=None, L1_minrmse=None, L1_warm_start=None, L1_weighted=None, features_dimensions: Optional[dict] = None, use_custodian: bool = True, custodian_job_kwargs: Optional[dict] = None, custodian_kwargs: Optional[dict] = None, run_dir: Union[None, str] = 'SISSO_dir', clean_run_dir: bool = False)[source]

SISSO regressor class compatible with scikit-learn.

__init__(ntask=1, task_weighting=1, desc_dim=2, restart=False, rung=2, opset='(+)(-)', maxcomplexity=10, dimclass=None, maxfval_lb=0.001, maxfval_ub=100000.0, subs_sis=20, method='L0', L1L0_size4L0=1, fit_intercept=True, metric='RMSE', nm_output=100, isconvex=None, width=None, nvf=None, vfsize=None, vf2sf=None, npf_must=None, L1_max_iter=None, L1_tole=None, L1_dens=None, L1_nlambda=None, L1_minrmse=None, L1_warm_start=None, L1_weighted=None, features_dimensions: Optional[dict] = None, use_custodian: bool = True, custodian_job_kwargs: Optional[dict] = None, custodian_kwargs: Optional[dict] = None, run_dir: Union[None, str] = 'SISSO_dir', clean_run_dir: bool = False)[source]

Construct SISSORegressor class.

All arguments not listed below are arguments from the SISSO code. For more information, see https://github.com/rouyang2017/SISSO.

Parameters

  • use_custodian – Whether to use custodian (currently mandatory).

  • custodian_job_kwargs – Keyword arguments for custodian job.

  • custodian_kwargs – Keyword arguments for custodian.

  • run_dir – Name of the directory where SISSO is run. If None, the directory will be set automatically. It then contains a timestamp and is unique.

  • clean_run_dir – Whether to clean the run directory after SISSO has run.