Skip to content

Commit

Permalink
FIX: small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
VincentAuriau committed Apr 17, 2024
1 parent 4dae9f0 commit f93920e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
14 changes: 5 additions & 9 deletions choice_learn/datasets/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ def load_modecanada(
Whether to split features by type in different dataframes, by default False.
to_wide : bool, optional
Whether to return the dataset in wide format,
by default False (an thus retuned in long format).
by default False (an thus returned in long format).
preprocessing : str, optional
Preprocessing to apply to the dataset, by default None
Expand Down Expand Up @@ -704,7 +704,7 @@ def load_heating(
Whether to return the description, by default False.
to_wide : bool, optional
Whether to return the dataset in wide format,
by default False (an thus retuned in long format).
by default False (an thus returned in long format).
Returns
-------
Expand Down Expand Up @@ -765,7 +765,7 @@ def load_electricity(
by default False.
to_wide : bool, optional
Whether to return the dataset in wide format,
by default False (an thus retuned in long format).
by default False (an thus returned in long format).
return_desc : bool, optional
Whether to return the description, by default False.
Expand Down Expand Up @@ -836,7 +836,7 @@ def load_train(
by default False.
to_wide : bool, optional
Whether to return the dataset in wide format,
by default False (an thus retuned in long format).
by default False (an thus returned in long format).
return_desc : bool, optional
Whether to return the description, by default False.
Expand Down Expand Up @@ -879,19 +879,15 @@ def load_car_preferences(
as_frame=False,
return_desc=False,
):
"""Load and return the Car dataset from McFadden et al. (1993).
"""Load and return the Car dataset from McFadden, Daniel and Kenneth Train (2000).
McFadden, Daniel and Kenneth Train (2000)
“Mixed MNL models for discrete response”, Journal of Applied Econometrics, 15(5), 447–470.
Parameters
----------
as_frame : bool, optional
Whether to return the dataset as pd.DataFrame. If not, returned as ChoiceDataset,
by default False.
to_wide : bool, optional
Whether to return the dataset in wide format,
by default False (an thus retuned in long format).
return_desc : bool, optional
Whether to return the description, by default False.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Here is a quick overview of the different functionalities offered by Choice-Lear

### Examples

Divers examples are provided in the How-To section, give it a look !
Diverse examples are provided in the How-To section, give it a look !

## Introduction - Discrete Choice Modelling

Expand Down

0 comments on commit f93920e

Please sign in to comment.