Skip to content

Conversation

@cwognum
Copy link
Collaborator

@cwognum cwognum commented Feb 7, 2025

Changelogs

  • Updated the documentation to reflect recent changes (e.g. DatasetV2 and BenchmarkV2)
  • Throw deprecation warnings for some old classes and methods we plan to phase out.

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, chore, documentation or test (or ask a maintainer to do it for you).

Some of our recent changes, e.g. DatasetV2 and BenchmarkV2, haven't been well documented. This was putting a large burden on myself to be very hands-on in the creation of new datasets and benchmarks. This PR drastically refactors the documentation to reflect recent changes and adds deprecation warnings for outdated pieces of code we want to phase out.

@cwognum cwognum added the documentation Improvements or additions to documentation label Feb 7, 2025
@cwognum cwognum self-assigned this Feb 7, 2025
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.

Wow, what a big change! Good timing for me to learn all the new APIs.
The tutorials are particularly well done – clear, concise, and easy to follow. Fantastic work!

@cwognum cwognum merged commit 8c35a28 into main Feb 7, 2025
19 checks passed
@cwognum cwognum deleted the docs/big-update branch February 7, 2025 20:23
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.

3 participants