Skip to content

Conversation

ashkan-software
Copy link
Member

Pull request information

Description

Update tutorials to match with the new way of running experiments. This is one of the tasks of #720 that was excluded from the PR as that PR was getting huge.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 4922

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.77%

Totals Coverage Status
Change from base Build 4916: 0.0%
Covered Lines: 8547
Relevant Lines: 9521

💛 - Coveralls

"\n",
"# create the experiment object\n",
"exp = Experiment(env)\n",
"flow_params = dict(\n",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add the descriptions to each parameter the way we do in the examples?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I removed the descriptions for 2 reasons: 1- It would make the tutorial kind of long. I realized most of code snippets in the tutorials are short, not to distract the reader. 2- Those parameters are all explained before in the tutorial.
@AboudyKreidieh I am open to discussing. What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good to me. So long as we agree it makes the tutorials clearer

Copy link
Member

@AboudyKreidieh AboudyKreidieh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Minor nit, open to discussing if you think it's not worth it

@ashkan-software
Copy link
Member Author

@AboudyKreidieh can you please check my last commit and confirm it is correct?

@AboudyKreidieh AboudyKreidieh merged commit d2cd893 into master Jan 5, 2020
@AboudyKreidieh AboudyKreidieh deleted the new_example_folder_next_steps branch January 5, 2020 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants