Adjust documentation after review #2175
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JanuszL
force-pushed
the
update_docs_after_review
branch
12 times, most recently
from
6000793
to
3d4c9ec
Compare
JanuszL
force-pushed
the
update_docs_after_review
branch
from
3d4c9ec
to
15ad1c7
Compare
|
!build |
|
CI MESSAGE: [1538926]: BUILD STARTED |
|
CI MESSAGE: [1538926]: BUILD FAILED |
|
CI MESSAGE: [1538926]: BUILD PASSED |
JanuszL
force-pushed
the
update_docs_after_review
branch
3 times, most recently
from
3cc1b0a
to
1dd7b04
Compare
mzient
reviewed
Sep 4, 2020
| .DocStr(R"code(Converts a Spectrogram to a mel Spectrogram using triangular filter banks. | ||
| Expects an input with 2 or more dimensions where the last two dimensions correspond to the | ||
| fft bin index and the window index respectively.)code") | ||
| .DocStr(R"code(Converts a Spectrogram to a mel spectrogram by using triangular filter banks. |
There was a problem hiding this comment.
Suggested change
| .DocStr(R"code(Converts a Spectrogram to a mel spectrogram by using triangular filter banks. | |
| .DocStr(R"code(Converts a spectrogram to a mel spectrogram by applying a bank of triangular filters. |
- Banks are not triangular. Filters are.
- It converts a spectrogram (data), not the operator.
mzient
reviewed
Sep 4, 2020
Comment on lines
48
to
49
| R"code(Determines whether to normalize the triangular filter weights by the width | ||
| of their mel bands. |
There was a problem hiding this comment.
Suggested change
| R"code(Determines whether to normalize the triangular filter weights by the width | |
| of their mel bands. | |
| R"code(Determines whether to normalize the triangular filter weights by the width | |
| of their frequency bands. |
The weights are normalized in input domain.
mzient
reviewed
Sep 4, 2020
| consistent with the implementation of the Hidden Markov Toolkit (HTK). | ||
| )code", | ||
| "slaney"); | ||
| R"code(Determines the formula that will be used to convert frequencies from Hertz to mel |
There was a problem hiding this comment.
Suggested change
| R"code(Determines the formula that will be used to convert frequencies from Hertz to mel | |
| R"code(Determines the formula that will be used to convert frequencies from hertz to mel |
mzient
reviewed
Sep 4, 2020
| )code", | ||
| "slaney"); | ||
| R"code(Determines the formula that will be used to convert frequencies from Hertz to mel | ||
| and from mel to Hertz. |
There was a problem hiding this comment.
Suggested change
| and from mel to Hertz. | |
| and from mel to hertz. |
mzient
reviewed
Sep 4, 2020
| R"code(Determines the formula that will be used to convert frequencies from Hertz to mel | ||
| and from mel to Hertz. | ||
|
|
||
| The mel scale is a perceptual scale of pitches, so there is no formula. |
There was a problem hiding this comment.
We select a formula and say there's not formula? The previous variant was much better.
mzient
reviewed
Sep 4, 2020
| 8192); | ||
| Unless specified otherwise, ``reference_power`` is typically the maximum of the signal. | ||
|
|
||
| Here is a list of the inputs and outputs: |
There was a problem hiding this comment.
Suggested change
| Here is a list of the inputs and outputs: | |
| Inputs and outputs: |
Hopefully we can insert an empty line. I think the original header was better.
mzient
reviewed
Sep 4, 2020
| .NumInput(1) | ||
| .NumOutput(detail::kNumOutputs) | ||
| .AddOptionalArg("cutoff_db", | ||
| R"code(The threshold [dB], below which everything is considered as silence.)code", |
There was a problem hiding this comment.
Suggested change
| R"code(The threshold [dB], below which everything is considered as silence.)code", | |
| R"code(The threshold, in dB, below which the signal is considered silent.)code", |
mzient
reviewed
Sep 4, 2020
Comment on lines
45
to
47
| .AddOptionalArg("window_length", R"code(Size of a sliding window. | ||
|
|
||
| This window is used to calculate the short-term power of the signal.)code", 2048) |
There was a problem hiding this comment.
Suggested change
| .AddOptionalArg("window_length", R"code(Size of a sliding window. | |
| This window is used to calculate the short-term power of the signal.)code", 2048) | |
| .AddOptionalArg("window_length", R"code(Size of the sliding window used in the calculation of | |
| the short-term power of the signal.)code", 2048) |
mzient
reviewed
Sep 4, 2020
|
|
||
| This window is used to calculate the short-term power of the signal.)code", 2048) | ||
| .AddOptionalArg("reference_power", | ||
| R"code(The reference power that is used to convert the signal to db. |
There was a problem hiding this comment.
Suggested change
| R"code(The reference power that is used to convert the signal to db. | |
| R"code(The reference power that is used to convert the signal to dB. |
mzient
reviewed
Sep 4, 2020
Comment on lines
51
to
52
| If a value for reference_power is not provided, the maximum value of the signal will be used as the | ||
| reference power.)code", |
There was a problem hiding this comment.
Suggested change
| If a value for reference_power is not provided, the maximum value of the signal will be used as the | |
| reference power.)code", | |
| If a value for reference_power is not provided, the maximum power of the signal will be used as the | |
| reference.)code", |
|
CI MESSAGE: [1641630]: BUILD STARTED |
|
CI MESSAGE: [1641630]: BUILD FAILED |
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
|
!build |
JanuszL
force-pushed
the
update_docs_after_review
branch
from
d4abed6
to
856997a
Compare
|
CI MESSAGE: [1641646]: BUILD STARTED |
|
CI MESSAGE: [1641646]: BUILD PASSED |
mzient
approved these changes
Sep 21, 2020
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
JanuszL
force-pushed
the
update_docs_after_review
branch
4 times, most recently
from
2237b9a
to
d1a6c28
Compare
|
!build |
JanuszL
force-pushed
the
update_docs_after_review
branch
from
d1a6c28
to
36a886c
Compare
|
CI MESSAGE: [1647716]: BUILD STARTED |
|
CI MESSAGE: [1647716]: BUILD FAILED |
JanuszL
force-pushed
the
update_docs_after_review
branch
from
36a886c
to
a292191
Compare
|
!build |
|
CI MESSAGE: [1647874]: BUILD STARTED |
|
CI MESSAGE: [1647874]: BUILD FAILED |
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
|
!build |
JanuszL
force-pushed
the
update_docs_after_review
branch
from
a292191
to
a170278
Compare
|
CI MESSAGE: [1648152]: BUILD STARTED |
|
CI MESSAGE: [1648152]: BUILD FAILED |
|
CI MESSAGE: [1648152]: BUILD PASSED |
18 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Janusz Lisiecki jlisiecki@nvidia.com
Why we need this PR?
Pick one, remove the rest
What happened in this PR?
Fill relevant points, put NA otherwise. Replace anything inside []
fixes a numerous language and formatting defects in the documentation
whole documentation
NA
CI build and documentation review of the output
Documentation has been updated
JIRA TASK: [DALI-1552]