AutoResearch / autora

Automated Research Assistant

https://autoresearch.github.io/autora/

MIT License

40 stars 5 forks source link

docs: add installation page to main documentation #505

Closed benwandrew closed 1 year ago

benwandrew commented 1 year ago

Description

resolves #464

Type of change

docs: Documentation only changes

Questions (Optional)

not sure where to put this... first page under "User Guide"?
also not sure what @musslick mean't by the last task -- "We should also consider adding the name of the autora pip/conda package for each tool in the main doc file (index.md) of the respectvie package."

Remarks (Optional)

to me, listing all the optional dependencies seems overkill and likely to get lost in the process of adding new ones going forward. as such, i opted to refer people to the pyproject.toml file for a complete list of options. this is comprehensive, and will necessarily be updated as optional dependencies are added. happy to change and create some sort of table, but aiming for effective viable solution that doesn't add documentation liability in the future...

musslick commented 1 year ago

Hey @benwandrew , regarding the last task: We should list the name of each optional dependency that can be installed with autora. Ideally in a table, e.g.,

| type | package name | description |  depenency |
-------------------------------------------------
| experimentalist | experimentalist-falsification | samples experimental conditions that are predicted to invalidate a model | optional |

musslick commented 1 year ago

@benwandrew Regarding the remark: I think we should still list all packages in the doc. Better an old list than no list at all. Pointing the user to the pytoml is cumbersome for them and will scare off unexperienced users.

musslick commented 1 year ago

Now resolved!

benwandrew commented 1 year ago

ok, all sounds good. and thanks for handling the list!

assume we're happy with placement as first page under User Guide?

musslick commented 1 year ago

ok, all sounds good. and thanks for handling the list!

assume we're happy with placement as first page under User Guide?

Actually, might be better right below "Introduction" and above "Tutorials"

benwandrew commented 1 year ago

@younesStrittmatter can you approve this when you get a chance? because you requested changes, it is not letting me merge until you approve. or perhaps i'm missing another outstanding requested change?

benwandrew commented 1 year ago

upon another quick read, wondering why certain samplers are listed as required dependencies? if this needs changing, i might also grab a couple typos in another PR...