generated from fastai/nbdev_template
-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathindex.html
77 lines (61 loc) · 4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
title: Fastai2 Audio
keywords: fastai
sidebar: home_sidebar
summary: "An audio module for v2 of fastai. We want to help you build audio machine learning applications while minimizing the need for audio domain expertise. Currently under development."
description: "An audio module for v2 of fastai. We want to help you build audio machine learning applications while minimizing the need for audio domain expertise. Currently under development."
---
<!--
#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: nbs/index.ipynb
# command to build the docs after a change: nbdev_build_docs
-->
<div class="container" id="notebook-container">
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Install">Install<a class="anchor-link" href="#Install"> </a></h2>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>In the future we will offer conda and pip installs, but as the code is rapidly changing, we recommend that only those interested in contributing and experimenting install for now. Everyone else should use <a href="https://github.com/mogwai/fastai_audio">Fastai audio v1</a></p>
<p>To install:</p>
<pre><code>pip install packaging
pip install git+https://github.com/rbracco/fastai2_audio.git</code></pre>
<p>If you plan on contributing to the library instead, you will need to do a editable install:</p>
<pre><code>pip install packaging nbdev --upgrade
git clone https://github.com/rbracco/fastai2_audio
cd fastai2_audio
nbdev_install_git_hooks
pip install -e ".[dev]"</code></pre>
<p>The final step sets up git hooks, which clean up the notebooks to remove the extraneous stuff stored in the notebooks (e.g. which cells you ran) which causes unnecessary merge conflicts.</p>
<p>Before submitting a PR, check that the local library and notebooks match. The script <code>nbdev_diff_nbs</code> can let you know if there is a difference between the local library and the notebooks.</p>
<ul>
<li>If you made a change to the notebooks in one of the exported cells, you can export it to the library with <code>nbdev_build_lib</code> or <code>make fastai2</code>.</li>
<li>If you made a change to the library, you can export it back to the notebooks with <code>nbdev_update_lib</code>.</li>
</ul>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h1 id="Contributors">Contributors<a class="anchor-link" href="#Contributors"> </a></h1><p>We are looking for contributors of all skill levels. If you don't have time to contribute, please at least reach out and give us some feedback on the library by posting in the <a href="https://forums.fast.ai/t/fastai-v2-audio/53535">v2 audio thread</a> or contact us via PM <a href="https://forums.fast.ai/u/baz/">@baz</a> or <a href="https://forums.fast.ai/u/MadeUpMasters/">@madeupmasters</a></p>
<h3 id="Active-Contributors">Active Contributors<a class="anchor-link" href="#Active-Contributors"> </a></h3><ul>
<li><a href="https://github.com/kevinbird15">kevinbird15</a></li>
<li><a href="https://github.com/mogwai">mogwai</a></li>
<li><a href="https://github.com/rbracco">rbracco</a></li>
<li><a href="https://github.com/hiromis">Hiromis</a></li>
<li><a href="https://github.com/scart97">scart97</a></li>
</ul>
<h3 id="How-to-contribute">How to contribute<a class="anchor-link" href="#How-to-contribute"> </a></h3><p>Create issues, write documentation, suggest/add features, submit PRs. We are open to anything. A good first step would be posting in the <a href="https://forums.fast.ai/t/fastai-v2-audio/53535">v2 audio thread</a> introducing yourself</p>
</div>
</div>
</div>
</div>