Skip to content

Commit

Permalink
Merge pull request #24 from ThomasBouche/docs/datasets_name
Browse files Browse the repository at this point in the history
add description "dataset_names"
  • Loading branch information
ThomasBouche committed Aug 12, 2022
2 parents b351825 + 774a133 commit 7df3dcd
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ sd = SmartDrift(
df_current=df_current,
df_baseline=df_baseline,
deployed_model=my_model, # Optional: put in perspective result with importance on deployed model
encoding=my_encoder # Optional: if deployed_model and encoder to use this model
encoding=my_encoder, # Optional: if deployed_model and encoder to use this model
dataset_names={"df_current": "Current dataset Name", "df_baseline": "Baseline dataset Name"} # Optional: Names for outputs
)
```

Expand Down
3 changes: 2 additions & 1 deletion docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ The 3 steps to display results:
df_current=df_current,
df_baseline=df_baseline,
deployed_model=my_model, # Optional: put in perspective result with importance on deployed model
encoding=my_encoder # Optional: if deployed_model and encoder to use this model
encoding=my_encoder, # Optional: if deployed_model and encoder to use this model
dataset_names={"df_current": "Current dataset Name", "df_baseline": "Baseline dataset Name"} # Optional: Names for outputs
)
Expand Down
3 changes: 2 additions & 1 deletion tutorial/tutorial01-Eurybia-overview.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,8 @@
"SD = SmartDrift(df_current=X_df_2007,\n",
" df_baseline=X_df_learning,\n",
" deployed_model=regressor, # Optional: put in perspective result with importance on deployed model\n",
" encoding=encoder # Optional: if deployed_model and encoder to use this model\n",
" encoding=encoder, # Optional: if deployed_model and encoder to use this model\n",
" dataset_names={\"df_current\": \"2007 dataset\", \"df_baseline\": \"Learning dataset\"} # Optional: Names for outputs\n",
" )"
]
},
Expand Down

0 comments on commit 7df3dcd

Please sign in to comment.