diff --git a/README.md b/README.md index 25ebc985fe0dc0f2526e1e990a3c5c3045907e32..f8bc0aa31b1f830685c141953f1322628bee54cf 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ The input parameters are stored in `sisso.json`, here is a list of all possible The name of the csv file where the data is stored. (Default: "data.csv") -#### `prop_key` +#### `property_key` The expression of the column where the property to be modeled is stored. (Default: "prop") @@ -106,6 +106,10 @@ The maximum rung of the feature (height of the tallest possible binary expressio Number of residuals to used to select the next subset of materials in the iteration. (Affects SIS after the 1D model) (Default: 1) +#### `n_models_store` + +Number of models to output as file for each dimension (Default: n_residual) + #### `n_rung_store` The number of rungs where all of the training/testing data of the materials are stored in memory. (Default: `max_rung` - 1) @@ -130,6 +134,14 @@ The indicies from the data set to use as the test set. If empty and `leave_out_f Fraction (in decimal form) of the data to use as a test set (Default: 0.0 if `leave_out_inds` is empty, otherwise `len(leave_out_inds)) / Number of rows in data file` +#### `fix_intercept` + +If true set the intercept to 0.0 for all models (Default: false) + +#### `max_feat_cross_correlation` + +The maximum Pearson correlation allowed between selected features (Default: 1.0) + ### Perform the Calculation Once the input files are made the code can be run using the following command