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

Docs: Revised basic tutorials #584

Merged
merged 15 commits into from
Dec 4, 2023
Merged

Docs: Revised basic tutorials #584

merged 15 commits into from
Dec 4, 2023

Conversation

chadcwilliams
Copy link
Collaborator

Description

Completed the basic tutorials with the latest AutoRA version to be released.

If the issue is on Github, simply link to it using the '#' symbol; otherwise, provide a notion page link):

Type of change

Delete as appropriate:

  • docs: Documentation only changes

@chadcwilliams chadcwilliams linked an issue Nov 30, 2023 that may be closed by this pull request
5 tasks
@benwandrew
Copy link
Collaborator

small point, but per our code style guidelines, notebooks should be "Camel case with spaces for Jupyter notebooks: Example Notebook.ipynb"

ie, no dashes

Copy link
Member

@hollandjg hollandjg left a comment

Choose a reason for hiding this comment

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

Hi Chad, for the newest version of the core which doesn't include aliases (and as such doesn't have the .model on the state – instead requiring you to use .models[-1]), there are some changes I'd suggest. These are in #587 which will merge onto this PR.

Also, to get this to run, you need to be running the newest pre-release of the synthetic abstract experiment runner – v0.0.8 (do pip install autora-synthetic-abstract-equation==0.0.8) – it includes support for random_state in the experiment_runner

docs/tutorials/basic/Tutorial-I-Components.ipynb Outdated Show resolved Hide resolved
docs/tutorials/basic/Tutorial-II-Loop-Constructs.ipynb Outdated Show resolved Hide resolved
Copy link
Member

@hollandjg hollandjg 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 to me!

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.

same here; looks good!

@chadcwilliams chadcwilliams added this pull request to the merge queue Dec 4, 2023
Merged via the queue into main with commit 31cac86 Dec 4, 2023
15 checks passed
@chadcwilliams chadcwilliams deleted the 569-revise-tutorial branch December 4, 2023 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revise tutorial
4 participants