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

DOC: simplify quickstart section #472

Merged
merged 4 commits into from
Dec 5, 2024
Merged

DOC: simplify quickstart section #472

merged 4 commits into from
Dec 5, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Nov 29, 2024

This simplifies the quickstart section by focusing on how to load a dataset and get the corresponding labels.
It shortens the section by removing:

And 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:

image

Summary by Sourcery

Documentation:

  • Simplify the quickstart section by focusing on loading datasets and obtaining labels, removing discussions on audb.available(), YAML representations, and reducing text.

Copy link
Contributor

sourcery-ai bot commented Nov 29, 2024

Reviewer's Guide by Sourcery

This 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

Change Details Files
Streamlined quickstart documentation content
  • Removed detailed discussion of audb.available()
  • Removed YAML header representations and db.descriptions
  • Reduced explanatory text
  • Added direct link to datasets documentation
  • Focused content on core dataset loading functionality
docs/quickstart.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@hagenw hagenw requested a review from ZYJGO December 4, 2024 13:07
@ZYJGO
Copy link

ZYJGO commented Dec 4, 2024

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

@hagenw
Copy link
Member Author

hagenw commented Dec 4, 2024

Would it be ok to add the following at the bottom of the page:

image

This requires that the dataset is already downloaded.
There is also the possibility to listen to an example file of a dataset, by downloading only that file:

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.

@ZYJGO
Copy link

ZYJGO commented Dec 4, 2024

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

@hagenw
Copy link
Member Author

hagenw commented Dec 4, 2024

I updated now the "Quickstart" section to show the example how to load the audio file with audiofile and how to listen to it with sounddevice.

And I created #477 to track adding a section on partial loading to the documentation.

@hagenw hagenw force-pushed the update-quickstart branch from 401f8cb to 8a6ea0f Compare December 5, 2024 08:19
docs/quickstart.rst Outdated Show resolved Hide resolved
@hagenw hagenw force-pushed the update-quickstart branch from 51452f4 to ad1ec37 Compare December 5, 2024 09:41
@hagenw hagenw force-pushed the update-quickstart branch from ad1ec37 to 1d489ab Compare December 5, 2024 09:58
@hagenw hagenw merged commit bb9a15a into main Dec 5, 2024
8 checks passed
@hagenw hagenw deleted the update-quickstart branch December 5, 2024 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants