docs: updated README #578
Merged
docs: updated README #578
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
musslick
requested review from
chadcwilliams,
benwandrew and
younesStrittmatter
README.md
Outdated
| ## Installation | ||
|
|
||
|
|
||
| We recommended using a `Python` environment manager like `virtualenv`. You may refer to the Development Guide on how to [set up a virtual environment](https://autoresearch.github.io/autora/contribute/setup/#create-a-virtual-environment). |
There was a problem hiding this comment.
"We recommended" should be "We recommend"
There was a problem hiding this comment.
Thanks for noticing this; fixed it!
| The discovery problem is defined by a single independent variable $x \in [0, 2 \pi]$ and dependent variable $y$. | ||
| The experiment amounts to a simple sine wave, $y = \sin(x)$, which is the model we are trying to discover. | ||
|
|
||
| Th discovery cycle iterates between the experimentalist, experiment runner, and theorist. Here, we us a "random" experimentalist, which samples novel experimental conditions for $x$ every cycle. |
| Before installing the PyPI ``autora`` package, you may [activate your environment](https://autoresearch.github.io/autora/contribute/setup/#activating-and-using-the-environment). To install the PyPI `autora` package, run the following command: | ||
|
|
||
| ```shell | ||
| pip install "autora" |
There was a problem hiding this comment.
Does autora need to be in quotes here? This is not the normal from my experience.
| Th discovery cycle iterates between the experimentalist, experiment runner, and theorist. Here, we us a "random" experimentalist, which samples novel experimental conditions for $x$ every cycle. | ||
| The experiment runner then collects data for the corresponding $y$ values. Finally, the theorist uses a [Bayesian Machine Scientist](https://autoresearch.github.io/autora/user-guide/theorists/bms/) (BMS; Guimerà et al., in Science Advances) to identify a scientific model that explains the data. | ||
|
|
||
| The workflow relies on the ``StandardState`` object, which stores the current state of the discovery process, such as ``conditions``, ``experiment_data``, or ``models``. The state is passed between the experimentalist, experiment runner, and theorist. |
There was a problem hiding this comment.
I would say
"such as conditions, experiment_data, or models"
should be
"such as conditions, experiment_data, and models"
| print('\n') | ||
|
|
||
| for i in range(5): | ||
| s = experimentalist(s, num_samples=10, random_state=42) |
There was a problem hiding this comment.
This is my error, sorry!
I would change the random state in both experimentalist and experiment_runner from random_state=42 to random_state=42+i because the former would use the same random state every cycle.
chadcwilliams
approved these changes
Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated readme file to resolve #529
Type of change
Delete as appropriate:
Features (Optional)
May need some help from @younesStrittmatter or @chadcwilliams to add a minimum example.