Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,15 @@
</div>

## 🧠 SlickML🧞 Philosophy
**SlickML** is an open-source machine learning library written in Python aimed
at accelerating the experimentation time for ML applications with tabular data while maximizing the amount of information can be inferred. Data Scientists'
tasks can often be repetitive such as feature selection, model tuning, or
evaluating metrics for classification and regression problems. We strongly believe that a good portion of the tasks based on tabular data can be addressed via gradient boosting and generalized linear models<sup>[1](https://arxiv.org/pdf/2207.08815.pdf)</sup>. SlickML provides
Data Scientists with a toolbox to quickly prototype solutions for a given problem with minimal code while maximizing the amount of information that can be inferred.
**SlickML** is an open-source machine learning library written in Python aimed at accelerating the
experimentation time for ML applications with tabular data while maximizing the amount of information
can be inferred. Data Scientists' tasks can often be repetitive such as feature selection, model
tuning, or evaluating metrics for classification and regression problems. We strongly believe that a
good portion of the tasks based on tabular data can be addressed via gradient boosting and generalized
linear models<sup>[1](https://arxiv.org/pdf/2207.08815.pdf)</sup>. SlickML provides Data Scientists
with a toolbox to quickly prototype solutions for a given problem with minimal code while maximizing
the amount of information that can be inferred. Additionally, the prototype solutions can be easily
promoted and served in production with our recommended recipes.


## 📖 Documentation
Expand Down Expand Up @@ -138,7 +142,7 @@ clf.plot_shap_waterfall()
✅ An example to train/validate a `GLMNetCV Classifier` with `Cross-Validation` and `Coefficients` visualizations:
```python
from slickml.classification import GLMNetCVClassifier
clf = GLMNetCVClassifier(alpha=0.3, n_splits=4, metric="roc_auc")
clf = GLMNetCVClassifier(alpha=0.3, n_splits=4, metric="auc")
clf.fit(X_train, y_train)
y_pred_proba = clf.predict_proba(X_test)

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ with tabular data while maximizing the amount of information can be inferred. Da
selection, model tuning, or evaluating metrics for classification and regression problems. We strongly believe that a good portion of the tasks
based on tabular data can be addressed via gradient boosting and generalized linear models `[1] <https://arxiv.org/pdf/2207.08815.pdf>`_.
SlickML provides Data Scientists with a toolbox to quickly prototype solutions for a given problem with minimal code while maximizing the amound
of information that can be inferred.
of information that can be inferred. Additionally, the prototype solutions can be easily promoted and served in production with our recommended recipes.


.. grid:: 1 2 2 2
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ clf.plot_shap_waterfall()
An example to train/validate a `GLMNetCVClassifier` with Cross-Validation and Coefficients visualizations:
```python
from slickml.classification import GLMNetCVClassifier
clf = GLMNetCVClassifier(alpha=0.3, n_splits=4, metric="roc_auc")
clf = GLMNetCVClassifier(alpha=0.3, n_splits=4, metric="auc")
clf.fit(X_train, y_train)
y_pred_proba = clf.predict_proba(X_test)

Expand Down
4 changes: 2 additions & 2 deletions src/slickml/base/_enum.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ class ExtendedEnum(Enum):
values()
Returns a list of Enum values as string

pairs()
Returns a dictionary of all Enum name-value pairs as string
to_dict()
Returns a dictionary of all Enum name-value pairs

Examples
--------
Expand Down