Better release notes
See original GitHub issueCurrently, datasets updates are poorly documented. The API isn’t great, and it requires versions to still be supported.
class MyDataset(tfds.core.GeneratorBasedBuilder):
VERSION = tfds.core.Version('2.0.1', release_note='Fix typo')
SUPPORTED_VERSIONS = [
tfds.core.Version('2.0.0', release_note='Add new field'),
tfds.core.Version('1.0.0', release_note='First release'),
]
Instead, it improve usability and discoverability to have an entirely separate field, independent of the supported version, like:
class MyDataset(tfds.core.GeneratorBasedBuilder):
VERSION = tfds.core.Version('2.0.1')
RELEASE_NOTES = {
'2.0.1': 'Fix typo',
'2.0.0': 'Add new field',
'1.0.0': 'First release',
}
Notes:
- This field should be added to
BuilderConfig
too. tfds new <>
template should be updated to haveRELEASE_NOTES = {...}
(to help discoverability)- Documentation should be updated in future PR to use this new field
Issue Analytics
- State:
- Created 3 years ago
- Comments:11 (11 by maintainers)
Top Results From Across the Web
How to write release notes (+5 great examples) | Appcues Blog
1. Make the intent of the changes clear · 2. Focus release notes on the user · 3. Explain changes with visuals ·...
Read more >How to Write Better Release Notes for SaaS - Beamer
Release notes need to let them know that your team is working hard to improve your product. Customers are loyal to services that...
Read more >51 of the best release notes examples (plus 11 free templates)
Release notes can cover anything from new updates and feature launches, to regular improvements and enhancements, to bug fixes of every kind.
Read more >Release Notes Best Practices: 7 Great Examples and Templates
First, you should have a simple language that is easy to understand. Second, the release notes should be short. Third, they should be...
Read more >Release Notes: Your Key To Feature Adoption (Best Practices ...
Release notes best practices: How to keep users engaged # · Don't be too technical # · Express your brand's personality # ·...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
By looking at the logs like
@NikhilBartwal I guess some of those errors are because of Windows OS. So, it not related to
RELEASE NOTES
.Related issue https://github.com/tensorflow/datasets/issues/1911#issuecomment-616224484 and pending part of PR https://github.com/tensorflow/datasets/pull/1916
ohh I havent seen that You already created it.