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

Update the documentation #5

Merged
merged 2 commits into from
May 23, 2024
Merged

Update the documentation #5

merged 2 commits into from
May 23, 2024

Conversation

cwognum
Copy link
Contributor

@cwognum cwognum commented May 23, 2024

Changelogs

  • BaseAction classes now reference the docs of the respective functional API.
  • Move docs from Field(description=...) to regular docstrings.

Checklist:

  • Was this PR discussed in an issue? It is recommended to first discuss a new feature into a GitHub issue before opening a PR.
  • Add tests to cover the fixed bug(s) or the newly introduced feature(s) (if appropriate).
  • Update the API documentation if a new function is added, or an existing one is deleted.
  • Write concise and explanatory changelogs above.
  • If possible, assign one of the following labels to the PR: feature, fix or test (or ask a maintainer to do it for you).

@cwognum cwognum added the documentation Improvements or additions to documentation label May 23, 2024
@cwognum cwognum requested a review from zhu0619 May 23, 2024 20:12
@cwognum cwognum self-assigned this May 23, 2024
@cwognum cwognum changed the title Docs pass Update the documentation May 23, 2024
Copy link
Contributor

@zhu0619 zhu0619 left a comment

Choose a reason for hiding this comment

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

Thanks @cwognum.
Just one minor thing to change.

auroris/cli.py Outdated Show resolved Hide resolved
auroris/curation/actions/_deduplicate.py Show resolved Hide resolved
@cwognum cwognum merged commit becae34 into fix/minor May 23, 2024
@cwognum cwognum deleted the fix/minor-cw branch May 23, 2024 20:43
cwognum added a commit that referenced this pull request May 23, 2024
* add ipython image

* minor fix

* allow image export to remote path

* minor changes

* change loglevel

* update chemspace viz

* add dup logger

* simplify distribution viz

* update outlier logs

* minor changes

* fix serialization

* add more docstrings

* fix docstring and extension

* update css

* minor change

* minor fix

* add dep

* Update auroris/curation/_curator.py

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* Update auroris/curation/actions/_mol.py

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* Update docs/index.md

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* Update auroris/visualization/_distribution.py

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* Update docs/index.md

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* update test_curator_save_load

* minor fix

* Update auroris/report/broadcaster/_logger.py

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* curator save/load

* avoid ipython image

* minor viz fix

* wip

* refactor image name

* Update docs/index.md

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* Update auroris/utils.py

Co-authored-by: Cas Wognum <caswognum@outlook.com>

* fix attribute discriminator

* fix report

* minor fix

* remove gcp

* update tutorial

* add pyarrow dep

* Update the documentation (#5)

* Docs pass

* Changed extension to parquet in CLI

---------

Co-authored-by: Cas Wognum <caswognum@outlook.com>
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.

None yet

2 participants