Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasMeissnerDS committed Oct 14, 2023
1 parent b7fc70f commit 13e78e3
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ the full documentation [here](https://bluecast.readthedocs.io/en/latest/).
* [Custom preprocessing](#custom-preprocessing)
* [Custom feature selection](#custom-feature-selection)
* [Custom ML model](#custom-ml-model)
* [Using the inbuilt ExperientTracker](#using-the-inbuilt-experienttracker)
* [Convenience features](#convenience-features)
* [Code quality](#code-quality)
* [Documentation](#documentation)
Expand Down Expand Up @@ -516,6 +517,36 @@ predicted_probas, predicted_classes = bluecast.predict(x_test)
Please note that custom ML models require user defined hyperparameter tuning. Pre-defined
configurations are not available for custom models.
#### Using the inbuilt ExperientTracker
For experimentation environments it can be useful to store all variables
and results from model runs.
BlueCast has an inbuilt experiment tracker to enhance the provided insights.
No setup is required. BlueCast will automatically store all necessary data
after each hyperparameter tuning trial.
```sh
# instantiate and train BlueCast
from bluecast.blueprints.cast import BlueCast

automl = BlueCast(
class_problem="binary",
target_column="target"
)

automl.fit_eval(df_train, df_eval, y_eval, target_col="target")

# access the experiment tracker
tracker = automl.experiment_tracker

# see all stored information as a Pandas DataFrame
tracker_df = tracker.retrieve_results_as_df()
```
Please note that the number of stored experiments will probably be lower
than the number of started hyperparameter tuning trials. The experiment tracker
is skipped whenever Optuna prunes a trial.
## Convenience features
Despite being a lightweight library, BlueCast also includes some convenience
Expand Down

0 comments on commit 13e78e3

Please sign in to comment.