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

Several bug fixes and improved documentation #4

Merged
merged 40 commits into from
May 23, 2024
Merged

Several bug fixes and improved documentation #4

merged 40 commits into from
May 23, 2024

Conversation

zhu0619
Copy link
Contributor

@zhu0619 zhu0619 commented May 17, 2024

Changelogs

  • Added the src_dataset_path attribute to the Curator for fully reproducible workflows.
  • Fix serialization of the Curator.steps.
  • Improved and added documentation in various places.
  • Several other minor fixes.

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).

@zhu0619 zhu0619 requested a review from cwognum as a code owner May 17, 2024 02:58
Copy link
Contributor

@cwognum cwognum left a comment

Choose a reason for hiding this comment

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

Thanks @zhu0619! I left some comments. I have been quite nitpicky, but I think it's important to be very intentional and careful in the decisions we make early and the example we set. This will simplify our lives later on. I made an effort to explain all my considerations.

auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/actions/_ac_stereoisomer.py Outdated Show resolved Hide resolved
auroris/curation/actions/_mol.py Outdated Show resolved Hide resolved
auroris/curation/_curator.py Outdated Show resolved Hide resolved
auroris/curation/actions/_mol.py Outdated Show resolved Hide resolved
zhu0619 and others added 10 commits May 17, 2024 10:02
Co-authored-by: Cas Wognum <caswognum@outlook.com>
Co-authored-by: Cas Wognum <caswognum@outlook.com>
Co-authored-by: Cas Wognum <caswognum@outlook.com>
Co-authored-by: Cas Wognum <caswognum@outlook.com>
Co-authored-by: Cas Wognum <caswognum@outlook.com>
Co-authored-by: Cas Wognum <caswognum@outlook.com>
@zhu0619 zhu0619 marked this pull request as draft May 22, 2024 04:52
@zhu0619 zhu0619 requested a review from cwognum May 23, 2024 05:25
@zhu0619 zhu0619 marked this pull request as ready for review May 23, 2024 05:25
@cwognum cwognum added the feature Annotates any PR that adds new features; Used in the release process label May 23, 2024
@cwognum cwognum added bug Something isn't working documentation Improvements or additions to documentation and removed feature Annotates any PR that adds new features; Used in the release process labels May 23, 2024
@cwognum cwognum changed the title Fix/minor Several bug fixes and improved documentation May 23, 2024
* Docs pass

* Changed extension to parquet in CLI
@cwognum cwognum merged commit 7127343 into main May 23, 2024
4 checks passed
@cwognum cwognum deleted the fix/minor branch May 23, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants