API - Minor cleanup

This commit is contained in:
dabinat 2019-03-22 10:08:13 -07:00
parent 0364bfa518
commit 26af3b292d
2 changed files with 5 additions and 5 deletions

View File

@ -181,7 +181,7 @@ struct ModelState {
*
* @return Vector of Output structs directly from the CTC decoder for additional processing.
*/
vector<Output> decode_raw(vector<float>& logits);
vector<Output> decode_raw(const vector<float>& logits);
/**
* @brief Return character-level metadata including letter timings.
@ -190,7 +190,7 @@ struct ModelState {
* n_frames * batch_size * num_classes
*
* @return Metadata struct containing MetadataItem structs for each character.
* The user is responsible for freeing Metadata and Metadata.items.
* The user is responsible for freeing Metadata by calling DS_FreeMetadata().
*/
Metadata* decode_metadata(vector<float>& logits);
@ -463,7 +463,7 @@ ModelState::decode(vector<float>& logits)
}
vector<Output>
ModelState::decode_raw(vector<float>& logits)
ModelState::decode_raw(const vector<float>& logits)
{
const int cutoff_top_n = 40;
const double cutoff_prob = 1.0;

View File

@ -133,7 +133,7 @@ char* DS_SpeechToText(ModelState* aCtx,
* @param aSampleRate The sample-rate of the audio signal.
*
* @return Outputs a struct of individual letters along with their timing information.
* The user is responsible for freeing Metadata and Metadata.items. Returns NULL on error.
* The user is responsible for freeing Metadata by calling {@link DS_FreeMetadata()}. Returns NULL on error.
*/
DEEPSPEECH_EXPORT
Metadata* DS_SpeechToTextWithMetadata(ModelState* aCtx,
@ -209,7 +209,7 @@ char* DS_FinishStream(StreamingState* aSctx);
* @param aSctx A streaming state pointer returned by {@link DS_SetupStream()}.
*
* @return Outputs a struct of individual letters along with their timing information.
* The user is responsible for freeing Metadata and Metadata.items. Returns NULL on error.
* The user is responsible for freeing Metadata by calling {@link DS_FreeMetadata()}. Returns NULL on error.
*
* @note This method will free the state pointer (@p aSctx).
*/