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.

Sign up for GitHub

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

Jump to bottom

Improve the documentation to run experiments with COMOKIT #4

Open
pierrelarmande opened this issue May 25, 2020 · 0 comments
Open

Improve the documentation to run experiments with COMOKIT #4

pierrelarmande opened this issue May 25, 2020 · 0 comments

Comments

@pierrelarmande
Copy link
Contributor

The documentation for running COMOKIT needs to be expanded.

  • documentation should guide the user to select an experiment
  • list all experiment available and describe them (purpose, models involved, output, etc.). For example, it's not clear what is the difference between "Abstract Batch Experiment" and "Abstract Experiment".
  • do we have documentation for the parameters allowed and their values?
  • do we have to set up parameters before running an experiment?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pierrelarmande