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

Doc/generalize tutorials #447

Merged
merged 4 commits into from
Jun 16, 2023
Merged

Doc/generalize tutorials #447

merged 4 commits into from
Jun 16, 2023

Conversation

musslick
Copy link
Collaborator

Description

I added general context for the main tutorials introducing an experimentalist and theorist.

Type of change

  • docs: Documentation only changes

Remarks (Optional)

  • @younesStrittmatter We would want to add, in a separate PR, a similar introduction to a simple closed-loop tutorial involving fire base.
  • @benwandrew We would want to add, in a separate PR< a similar introduction to a synthetic closed-loop tutorial.

@musslick musslick added the documentation Improvements or additions to documentation. label Jun 15, 2023
@musslick musslick self-assigned this Jun 15, 2023
Copy link
Collaborator

@benwandrew benwandrew left a comment

Choose a reason for hiding this comment

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

added a couple language edits in the theorist notebook and made a note about new experimentalist image, but otherwise this looks great!

"\n",
"![Experimentalist](../img/experimentalist.png)\n",
"\n",
"Experimentalists may use information about candidate models $M$ obtained from a theorist,\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

just a note: i think with the new image for the experimentalist (https://github.com/AutoResearch/autora/blob/doc/exp-module/docs/img/experimentalist.png), there is no longer direct correspondence from this language to M, X, Y in an image. not a big deal, just FYI.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Awesome, thank you! Yes, I decided top drop the formal language; I think it overcomplicates things and is harder to track for consistency across the different module types.

Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

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

looks good

@musslick musslick added this pull request to the merge queue Jun 16, 2023
Merged via the queue into main with commit e91051d Jun 16, 2023
@musslick musslick deleted the doc/generalize-tutorials branch June 16, 2023 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants