Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write docstrings for dataset generators #81

Open
kiudee opened this issue Jan 20, 2020 · 0 comments
Open

Write docstrings for dataset generators #81

kiudee opened this issue Jan 20, 2020 · 0 comments
Labels
Maintenance Documentation, tests, CI etc Priority: Low

Comments

@kiudee
Copy link
Owner

kiudee commented Jan 20, 2020

Dataset generators like

class ChoiceDatasetGenerator(SyntheticDatasetGenerator):
def __init__(self, dataset_type='pareto', **kwargs):
super(ChoiceDatasetGenerator, self).__init__(
learning_problem=CHOICE_FUNCTION, **kwargs)
dataset_function_options = {'linear': self.make_latent_linear_choices,
"pareto": self.make_globular_pareto_choices}
if dataset_type not in dataset_function_options.keys():
dataset_type = "pareto"
self.dataset_function = dataset_function_options[dataset_type]
inherit the docstring of the parent class, which is not very informative.

@kiudee kiudee added Maintenance Documentation, tests, CI etc Priority: Low labels Feb 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Documentation, tests, CI etc Priority: Low
Projects
None yet
Development

No branches or pull requests

1 participant