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

Please add link to api doc for perform_experiments #54

Closed
stefaneidelloth opened this issue Mar 28, 2019 · 5 comments
Closed

Please add link to api doc for perform_experiments #54

stefaneidelloth opened this issue Mar 28, 2019 · 5 comments
Labels

Comments

@stefaneidelloth
Copy link

In the python tutorial it says

The function perform_experiments() takes the model we just specified and will execute 100 experiments. By default, these experiments are generated using a Latin Hypercube sampling, but Monte Carlo sampling and Full factorial sampling are also readily available. Read the documentation for perform_experiments() for more details.

But where to find that documentation? If I search the doc for "perform_experiments" I get some results but not the actual doc for perform_experiments.
=>Please add a direct link to the corresponding doc in the tutorial.

@stefaneidelloth
Copy link
Author

stefaneidelloth commented Mar 28, 2019

@stefaneidelloth
Copy link
Author

stefaneidelloth commented Apr 30, 2019

Hi, you stated

I am close to releasing a major update where the experiments are stored in a pandas dataframe

=>Could you please give an estimate when the structure of the results will be changed? Will that correspond to version 3.0 on https://pypi.org/project/ema-workbench/ ?

@quaquel
Copy link
Owner

quaquel commented Apr 30, 2019

I released this on pip 2 weeks ago, it is part of the V2 version of the workbench.

@stefaneidelloth
Copy link
Author

Ok. Then only the doc needs some update. It still states that the experiments are a numpy recarray

Returns: | the experiments as a numpy recarray,
https://emaworkbench.readthedocs.io/en/latest/ema_documentation/em_framework/evaluators.html

@quaquel
Copy link
Owner

quaquel commented Apr 30, 2019

yes, thanks for noticing it.

Accidentally, I noticed this one myself yesterday while working on the 2.1 branch. I have fixed it there already but will fix it in 2.0 as well.

@quaquel quaquel closed this as completed May 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants