-
Notifications
You must be signed in to change notification settings - Fork 1
/
cli.html
272 lines (184 loc) · 8.58 KB
/
cli.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Command Line Interface</title>
<link rel="stylesheet" href="_static/pygments.css">
<link rel="stylesheet" href="_static/theme.css">
<link rel="stylesheet" href="_static/sphinx_press_theme.css">
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<!-- sphinx script_files -->
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script src="_static/theme-vendors.js"></script>
<script src="_static/theme.js" defer></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Music Transcription" href="music.html" />
<link rel="prev" title="Quick Start" href="quick-start.html" />
</head>
<body>
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
<router-link to="index.html" class="home-link">
<span class="site-name">omnizart</span>
</router-link>
<div class="links">
<navlinks class="can-hide">
<div class="nav-item">
<a href="index.html#omniscient-mozart-s-document"
class="nav-link router-link-active">
Contents
</a>
</div>
<div class="nav-item">
<a href="index.html#omniscient-mozart-s-document"
class="nav-link ">
API Reference
</a>
</div>
</navlinks>
</div>
</navbar>
<div class="sidebar-mask" @click="toggleSidebar(false)">
</div>
<sidebar @toggle-sidebar="toggleSidebar">
<navlinks>
<div class="nav-item">
<a href="index.html#omniscient-mozart-s-document"
class="nav-link router-link-active">
Contents
</a>
</div>
<div class="nav-item">
<a href="index.html#omniscient-mozart-s-document"
class="nav-link ">
API Reference
</a>
</div>
</navlinks><div id="searchbox" class="searchbox" role="search">
<div class="caption"><span class="caption-text">Quick search</span>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
<div class="sidebar-group">
<p class="caption">
<span class="caption-text"><a href="index.html#omniscient-mozart-s-document">Contents</a></span>
</p>
<ul class="current">
<li class="toctree-l1 "><a href="quick-start.html" class="reference internal ">Quick Start</a>
</li>
<li class="toctree-l1 current"><a href="#" class="reference internal current">Command Line Interface</a>
<ul>
<li class="toctree-l2"><a href="#module-omnizart.cli.transcribe" class="reference internal">Transcribe</a></li>
</ul>
</li>
</ul>
</div>
<div class="sidebar-group">
<p class="caption">
<span class="caption-text"><a href="index.html#omniscient-mozart-s-document">API Reference</a></span>
</p>
<ul class="">
<li class="toctree-l1 "><a href="music.html" class="reference internal ">Music Transcription</a>
</li>
<li class="toctree-l1 "><a href="drum.html" class="reference internal ">Drum Transcription</a>
</li>
<li class="toctree-l1 "><a href="feature.html" class="reference internal ">Feature</a>
</li>
<li class="toctree-l1 "><a href="models.html" class="reference internal ">Models</a>
</li>
<li class="toctree-l1 "><a href="training.html" class="reference internal ">Training</a>
</li>
<li class="toctree-l1 "><a href="base.html" class="reference internal ">Base Classes</a>
</li>
<li class="toctree-l1 "><a href="constants.html" class="reference internal ">Constants</a>
</li>
<li class="toctree-l1 "><a href="utils.html" class="reference internal ">Utilities</a>
</li>
</ul>
</div>
</div>
</sidebar>
<page>
<div class="body-header" role="navigation" aria-label="navigation">
<ul class="breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Command Line Interface</li>
</ul>
<ul class="page-nav">
<li class="prev">
<a href="quick-start.html"
title="previous chapter">← Quick Start</a>
</li>
<li class="next">
<a href="music.html"
title="next chapter">Music Transcription →</a>
</li>
</ul>
</div>
<hr>
<div class="content" role="main">
<div class="section" id="command-line-interface">
<h1>Command Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h1>
<p>This page describes the basic concept and usage of <code class="docutils literal notranslate"><span class="pre">omnizart</span></code> command.</p>
<p>The root entry is <code class="docutils literal notranslate"><span class="pre">omnizart</span></code>, and followed by several sub-commands. To see a list of available sub-commands, type <code class="docutils literal notranslate"><span class="pre">omnizart</span> <span class="pre">--help</span></code>.</p>
<p>More detailed descriptions and the usage of each sub-commands can be found from their own page.</p>
<div class="section" id="module-omnizart.cli.transcribe">
<span id="transcribe"></span><h2>Transcribe<a class="headerlink" href="#module-omnizart.cli.transcribe" title="Permalink to this headline">¶</a></h2>
<p>Collections of transcription commands.</p>
<p>Transcribes the audio in different aspects, such as instrument, drum, and vocal. Specify <cite>all</cite> to the first
argument to transcribe all different aspects. The output will be a MIDI file with the same name as the
input audio, except the extension will be replaced with ‘.mid’.</p>
<p>
Available functions are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">music</span></code> - trancribes instrument notes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drum</span></code> - transcribes drum percussions</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vocal</span></code> - transcribes vocal melodies</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">beat</span></code> - MIDI-domain beat tracking</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">chord</span></code> - MIDI-domain chord transcription</p></li>
</ul>
<p>Input for the former three should be wav file, and the last two
should be MIDI file.</p>
<p>Example Usage</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ omnizart transcribe music <span class="se">\ </span>
example.wav <span class="se">\ </span>
--model-path path/to/model <span class="se">\ </span>
--output example.mid
</pre></div>
</div>
</div>
</div>
</div>
<div class="page-nav">
<div class="inner"><ul class="page-nav">
<li class="prev">
<a href="quick-start.html"
title="previous chapter">← Quick Start</a>
</li>
<li class="next">
<a href="music.html"
title="next chapter">Music Transcription →</a>
</li>
</ul><div class="footer" role="contentinfo">
© Copyright 2020, BreezeWhite.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
</div>
</div>
</div>
</page>
</div>
</body>
</html>