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
[Cherry-picked 0.9] Update docs #1550
Conversation
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.
LGTM
* Use `bibtex` for paper citations. * add `override.css` for fixing back reference. * wav2vec2 * wav2letter * convtasnet * deepspeech * rnnt-loss * griffinlim * Fix broken references in `filtering`. * Fix note in soundfile backends. * Tweak wav2vec2 example. * Removes unused `pytorch_theme.css`
@@ -1215,7 +1206,7 @@ def compute_kaldi_pitch( | |||
recompute_frame: int = 500, | |||
snip_edges: bool = True, | |||
) -> torch.Tensor: | |||
"""Extract pitch based on method described in [1]. |
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.
@mthrok and @carolineechen -- I do not see a discussion for the use of bibtex. Can you point to me where this is used in pytorch/text/vision? Was this discussed internally somewhere? Though I love bibtex for long free form document, this is not the appropriate choice here. On the web, this renders okay. However,
- python and ipython only show the :footcite: reference and the user wouldn't know where to look for the actual reference.
- this is inconsistent reference styling with other weblinks as they are still simply linked in the docstring, e.g. functional vad.
> help(torchaudio.functional.compute_kaldi_pitch)
Help on function compute_kaldi_pitch in module torchaudio.functional.functional:
compute_kaldi_pitch(waveform: torch.Tensor, sample_rate: float, frame_length: float = 25.0, frame_shift: float = 10.0, min_f0: float = 50, max_f0: float = 400, soft_min_f0
: float = 10.0, penalty_factor: float = 0.1, lowpass_cutoff: float = 1000, resample_frequency: float = 4000, delta_pitch: float = 0.005, nccf_ballast: float = 7000, lowpas
s_filter_width: int = 1, upsample_filter_width: int = 5, max_frames_latency: int = 0, frames_per_chunk: int = 0, simulate_first_pass_online: bool = False, recompute_frame:
int = 500, snip_edges: bool = True) -> torch.Tensor
Extract pitch based on method described in :footcite:`6854049`.
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.
Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com>
* Update build.sh Picks up 1.9 build from test. * Update build.sh * Update lite interpreter tutorial to beta (pytorch#1549) * Update lite interpreter tutorial to beta * Update lite interpreter to beta * update model export script * address comment and update documentation * add custome build in first paragraph * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * replace file name * update ios part Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Revert "Update lite interpreter tutorial to beta (pytorch#1549)" (pytorch#1569) This reverts commit a702ca0fafe9d4a1ee0c1e4331de66245ceb3103. * Update build.sh * Update build.sh * updated pipeline tutorial (pytorch#1562) * reduce (pytorch#1546) * Update seq2seq_translation_tutorial.py (pytorch#1532) Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> * added CPU optimization guide part into tuning_guide (pytorch#1512) * added CPU optimization guide part into tuning_guide * changed non-python command to python comments in CPU specific optimization section * Update tuning_guide.py Changed comment of bash commands to double quote. * Update tuning_guide.py Co-authored-by: Brian Johnson <brianjo@fb.com> * Typo fix (pytorch#1538) Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> * Typo fix in text sentiment tutorial (pytorch#1543) Trivial typo fix in docs * Update dcgan_faces_tutorial.py (pytorch#1550) Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> * updated pipeline tutorial Co-authored-by: define_liuyi <793753866@qq.com> Co-authored-by: dhayeah <57786651+dhayeah@users.noreply.github.com> Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> Co-authored-by: Jing Xu <jing.xu@intel.com> Co-authored-by: Brian Johnson <brianjo@fb.com> Co-authored-by: Andrew C. Freeman <andrew.freeman@cawb.com> Co-authored-by: Davide Fiocco <davidefiocco@users.noreply.github.com> Co-authored-by: universuen <52519513+universuen@users.noreply.github.com> * Update audio manipulation tutorial (pytorch#1566) * add resampling tutorial * update benchmarking and sectioning * remove np import * Update torchaudio tutorial * update resample dtype initialization Co-authored-by: moto <855818+mthrok@users.noreply.github.com> * updated text sentiment tutorial (pytorch#1563) * updated transformer tutorial (pytorch#1565) * Update numeric_suite_tutorial.py s/Logger=/logger_cls=/ * Update profiler recipe doc (1.9) (pytorch#1528) Summary: Update the profiler recipe to use the new API and features Test Plan: make html-noplot Co-authored-by: Brian Johnson <brianjo@fb.com> * Update build.sh Co-authored-by: cccclai <chenlai@fb.com> Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> Co-authored-by: parmeet <parmeetbhatia@fb.com> Co-authored-by: define_liuyi <793753866@qq.com> Co-authored-by: dhayeah <57786651+dhayeah@users.noreply.github.com> Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> Co-authored-by: Jing Xu <jing.xu@intel.com> Co-authored-by: Andrew C. Freeman <andrew.freeman@cawb.com> Co-authored-by: Davide Fiocco <davidefiocco@users.noreply.github.com> Co-authored-by: universuen <52519513+universuen@users.noreply.github.com> Co-authored-by: Caroline Chen <carolinechen@fb.com> Co-authored-by: moto <855818+mthrok@users.noreply.github.com> Co-authored-by: Nikita Shulga <nshulga@fb.com> Co-authored-by: ilia-cher <30845429+ilia-cher@users.noreply.github.com>
Addresses most of doc-related issues in #1527
bibtex
for paper citations.override.css
for fixing back reference.filtering
.pytorch_theme.css
You can check out the resulting doc here: https://228264-90321822-gh.circle-artifacts.com/0/docs/models.html#references