-
Notifications
You must be signed in to change notification settings - Fork 1
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
DOC: simplify quickstart section #472
Conversation
Reviewer's Guide by SourceryThis PR simplifies the quickstart documentation by streamlining the content to focus on essential dataset loading operations. The changes primarily involve removing verbose explanations and redundant information to create a more concise, single-screen guide. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @hagenw - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
it would be great to also have a section for playing a sample, since people(at least i) often want to listen to one after loading the dataset:) |
Would it be ok to add the following at the bottom of the page: This requires that the dataset is already downloaded. db = audb.load("emodb", version="1.4.1", only_metadata=True, full_path=False)
media = audb.load_media("emodb", db.files[0], version="1.4.1")
signal, sampling_rate = audiofile.read(media[0], always_2d=True) But I think, I would prefer to add those to a "Partial Loading" section under https://audeering.github.io/audb/load.html, where we can also discuss how to load a single table. |
okay i agree, just playing a random sample doesn't make much sense since we can also hear it here. adding it to "Partial Loading" and making it more functional maybe better |
I updated now the "Quickstart" section to show the example how to load the audio file with And I created #477 to track adding a section on partial loading to the documentation. |
401f8cb
to
8a6ea0f
Compare
51452f4
to
ad1ec37
Compare
ad1ec37
to
1d489ab
Compare
This simplifies the quickstart section by focusing on how to load a dataset and get the corresponding labels.
It shortens the section by removing:
audb.avilable()
, instead we only link to https://audeering.github.io/datasets/datasets.htmldb.descriptions
and other YAML representations of the headerAnd adds a small signal, how to load and listen to an audio file.
The updated quickstart documentation now fits on a single screen page and looks like this:
Summary by Sourcery
Documentation:
audb.available()
, YAML representations, and reducing text.