AutoResearch / autora

Automated Research Assistant

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

MIT License

41 stars 5 forks source link

Doc: extension of contribution documentation #445

Closed musslick closed 1 year ago

musslick commented 1 year ago

Description

I revised/added some of the main contribution doc, such as for core contributions, module contributions, theorist contributions, and experimentalist contributions.

Type of change

Delete as appropriate:

docs: Documentation only changes

Features (Optional)

bulleted list of features, describing the code contributions in this pull request

Questions (Optional)

@younesStrittmatter Would it be possible to add an experiment_runner-module.md describing the different types of contributions (following the structure in theorist-module.md and experimentalist-module.md)? This would also be the place where we should list synthetic data/experiment runners.

benwandrew commented 1 year ago

btw, i love the new color-coded images specific to theorist, experimentalist, and experiment runner!

benwandrew commented 1 year ago

i see a number of suggestions were ignored (which is totally fine!!), but i did want to confirm these two:

https://github.com/AutoResearch/autora/pull/445/files#r1232023162 https://github.com/AutoResearch/autora/pull/445/files#r1232016544

i know it's just illustrative, but doesn't python need underscores in the directories and function names?

that's why i changed theorist-module.md in this tiny PR

cc @younesStrittmatter

younesStrittmatter commented 1 year ago

Yes, I also think this should be adressed:

https://github.com/AutoResearch/autora/pull/445/files#r1232023162 https://github.com/AutoResearch/autora/pull/445/files#r1232016544