Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukassnoek authored Jan 10, 2022
1 parent d38ebd7 commit b61beef
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ Note that both functions expect two (mandatory) arguments:
* `X`: a *pandas* `DataFrame` with predictors/features in columns and observations in rows;
* `y`: a *pandas* `Series` with observations in rows

In addition, you can estimate the variability of the noise ceiling using the `run_bootstraps_nc` function, which accepts an addition keyword, `classification` (a bool), which indicates whether a categorical (`True`) or continuous (`False`) noise ceiling should be estimated.
In addition, you can estimate the variability of the noise ceiling using the `run_bootstraps_nc` function, which accepts an addition keyword, `classification` (a bool), which indicates whether a categorical (`True`) or continuous (`False`) noise ceiling should be estimated.

## Notes
Although the functions from this package work for any column type in `X` (integer, float, string), the noise ceiling functions are about an order of magnitude faster when all columns are of a numeric type (i.e., no strings). Therefore, I'd recommend encoding string-based values (e.g., category levels) as integers.

0 comments on commit b61beef

Please sign in to comment.