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

chore: Formatting notebooks #73

Merged
merged 8 commits into from Dec 8, 2020
Merged

chore: Formatting notebooks #73

merged 8 commits into from Dec 8, 2020

Conversation

scart97
Copy link
Collaborator

@scart97 scart97 commented Dec 7, 2020

This pull request has the objective to clean small formatting problems on the tutorial notebooks so they render better on the docs page, and also remove some references to things from fastai v1 that don't make sense anymore, like using the full 10 speakers dataset when we only need one audio file.

The only code change was updating the link of 10 speakers sample. As both it and ESC-50 downloaded a file called master.zip, there could be problems where both files got mixed in the fastai cache and you end up with the wrong dataset.

For the notebook changes:

ESC-50:
* Removed empty cells
* Save output of show_batch and the training so users know what to expect while reading the tutorial
* Fix headings so Table of Contents is rendered correctly

Training tutorial:
* Removed, it's exactly the same file as ESC50

Introduction to fastaudio:
* Change data to 10 speakers sample from full 10 speakers

Introduction to audio:
* Removed Table of contents, as the docs page creates one
* Fix headings
* Remove reference to notebooks that don't exist
* Change data to 10 speakers sample from full 10 speakers

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@scart97
Copy link
Collaborator Author

scart97 commented Dec 7, 2020

The rules for the toc rendering correctly are the follow:
The first cell should be a h1 heading (# Title)
All of the following cells that are headings should be h2 or more (## Section heading)

@scart97
Copy link
Collaborator Author

scart97 commented Dec 7, 2020

Example of the automatic TOC rendering correctly:
Screenshot from 2020-12-07 16-25-08

@codecov
Copy link

codecov bot commented Dec 7, 2020

Codecov Report

Merging #73 (7534d6e) into master (d6d61aa) will decrease coverage by 0.30%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #73      +/-   ##
==========================================
- Coverage   90.88%   90.57%   -0.31%     
==========================================
  Files          12       12              
  Lines         647      647              
  Branches       70       70              
==========================================
- Hits          588      586       -2     
- Misses         32       34       +2     
  Partials       27       27              
Impacted Files Coverage Δ
src/fastaudio/core/signal.py 81.25% <ø> (-2.09%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6d61aa...7534d6e. Read the comment docs.

@scart97 scart97 requested a review from mogwai December 7, 2020 20:04
@mogwai mogwai merged commit 689fcc1 into master Dec 8, 2020
@mogwai mogwai deleted the formatting-notebooks branch December 8, 2020 10:22
@github-actions
Copy link

github-actions bot commented Dec 8, 2020

🎉 This PR is included in version 0.1.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants