ENH: Add CITATION.cff and prepare Zenodo integration #1494
Conversation
for more information, see https://pre-commit.ci
…grawal/openml-python into fix/1210-auth-warning
for more information, see https://pre-commit.ci
|
@PGijsbers This PR is ready for review! It includes the Once this is merged, a repository admin will just need to enable the repository in the Zenodo settings to start archiving future releases. |
- Implements edit_flow function to edit custom_name, tags, language, and description fields - Follows the same pattern as edit_dataset function - Adds comprehensive tests for the new functionality - Updates __init__.py to expose the new function in the public API - Addresses issue openml#896: Edit (some) fields of flow after upload The function allows flow owners to edit non-critical metadata fields while preserving flow integrity and preventing unauthorized edits.
for more information, see https://pre-commit.ci
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Some questions about the changes to the cff file.
Please also remove the changes to flows and tests from this PR as these changes are unrelated to Zenodo integration.
| orcid: "https://orcid.org/0000-0002-2037-3694" | ||
| journal: "Journal of Machine Learning Research" | ||
| title: "OpenML-Python: an extensible Python API for OpenML" | ||
| abstract: "OpenML is an online platform for open science collaboration in machine learning, used to share datasets and results of machine learning experiments. In this paper, we introduce OpenML-Python, a client API for Python, which opens up the OpenML platform for a wide range of Python-based machine learning tools. It provides easy access to all datasets, tasks and experiments on OpenML from within Python. It also provides functionality to conduct machine learning experiments, upload the results to OpenML, and reproduce results which are stored on OpenML. Furthermore, it comes with a scikit-learn extension and an extension mechanism to easily integrate other machine learning libraries written in Python into the OpenML ecosystem. Source code and documentation are available at https://github.com/openml/openml-python/." |
There was a problem hiding this comment.
What is the reason for removing text that is officially part of the abstract?
| authors: | ||
| - family-names: "Feurer" | ||
| given-names: "Matthias" | ||
| - family-names: "Gijsbers" | ||
| given-names: "Pieter" | ||
| - family-names: "Vanschoren" | ||
| given-names: "Joaquin" |
There was a problem hiding this comment.
Why are (only) these three people chosen? What is supposed to be in this field if we already reference the preferred-citation?
There was a problem hiding this comment.
I initially mirrored the authors from the JMLR paper to ensure consistency with the preferred citation.
However, I understand that the top-level authors field is intended for the software contributors, which is a broader group. Would you prefer I:
- List the current core maintainers.
- Attempt to list all major contributors?
- Use a collective name like "The OpenML Python Contributors"?
Let me know your preference, and I will update it immediately!
|
@PGijsbers Thanks for the review! I have updated the PR based on your feedback:
Ready for re-review! |
2 participants
Reference Issue: Fixes #1334
New Tests Added: NA
Documentation Updated: Yes
Change Log Entry: Add CITATION.cff and Zenodo release documentation
Details
Description
This PR prepares the repository for Zenodo integration as discussed in issue #1334.
Changes
Added CITATION.cff: Configured to use the JMLR 2021 paper (Feurer et al.) as the preferred-citation. This ensures users citing the software are directed to the correct academic publication, rather than just the source code.
Updated README: Added a placeholder for the Zenodo DOI badge in the header.
Updated Documentation: Added a note in CONTRIBUTING.md (Appendix) regarding the Zenodo release workflow to guide future maintainers.