Rename 'foreign language' to 'specified language' (#66)

HumeAI · Jun 9, 2023 · 5a55949 · 5a55949
1 parent ed5ba3c
commit 5a55949
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 14 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -10,15 +10,15 @@ Some notebooks have requirements beyond the Hume Python SDK. To install these ru
 
 ## Notebooks
 
-| API                                              | Models                                                                                                                      | Extras                                                  | Link                                                                                          |
-| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| [batch](https://docs.hume.ai/doc/batch-api)      | [`face`](https://help.hume.ai/models/facial-expression), [`facs`](https://help.hume.ai/models/facial-expression)            | Download results as CSV file                            | [Notebook](./batch-facial-action-coding-system/batch-facial-action-coding-system.ipynb)       |
-| [batch](https://docs.hume.ai/doc/batch-api)      | [`language`](https://help.hume.ai/models/emotional-language), [`sentiment`](https://help.hume.ai/models/emotional-language) | Download results as JSON file                           | [Notebook](./batch-text-sentiment-analysis/batch-text-sentiment-analysis.ipynb)               |
-| [batch](https://docs.hume.ai/doc/batch-api)      | [`burst`](https://help.hume.ai/models/vocal-bursts), [`prosody`](https://help.hume.ai/models/speech-prosody)                | Webhook callback                                        | [Notebook](./batch-voice-expression/batch-voice-expression.ipynb)                             |
-| [batch](https://docs.hume.ai/doc/batch-api)      | [`language`,](https://help.hume.ai/models/emotional-language) [`toxicity`](https://help.hume.ai/models/emotional-language)  | Enable email notification                               | [Notebook](./batch-text-toxicity-detection/batch-text-toxicity-detection.ipynb)               |
-| [batch](https://docs.hume.ai/doc/batch-api)      | [`language`,](https://help.hume.ai/models/emotional-language) [`ner`](https://help.hume.ai/models/emotional-language)       | Submit a file from your local disk                      | [Notebook](./batch-text-entity-recognition/batch-text-entity-recognition.ipynb)               |
-| [batch](https://docs.hume.ai/doc/batch-api)      | [`prosody`](https://help.hume.ai/models/speech-prosody)                                                                     | Foreign language support                                | [Notebook](./batch-foreign-language-transcription/batch-foreign-language-transcription.ipynb) |
-| [stream](https://docs.hume.ai/doc/streaming-api) | [`facemesh`](https://help.hume.ai/models/facial-expression)                                                                 |                                                         | [Notebook](./stream-anonymized-facemesh/stream-anonymized-facemesh.ipynb)                     |
-| [stream](https://docs.hume.ai/doc/streaming-api) | [`face`](https://help.hume.ai/models/facial-expression)                                                                     | Face identification                                     | [Notebook](./stream-face-expression/stream-face-expression.ipynb)                             |
-| [stream](https://docs.hume.ai/doc/streaming-api) | [`language`](https://help.hume.ai/models/emotional-language)                                                                | Send raw text over websocket                            | [Notebook](./stream-text-emotion/stream-text-emotion.ipynb)                                   |
-| [stream](https://docs.hume.ai/doc/streaming-api) | [`burst`](https://help.hume.ai/models/vocal-bursts), [`prosody`](https://help.hume.ai/models/speech-prosody)                | Stream media from in memory bytes, reset stream context | [Notebook](./stream-voice-expression/stream-voice-expression.ipynb)                           |
+| API                                              | Models                                                                                                                      | Extras                                                  | Link                                                                                              |
+| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| [batch](https://docs.hume.ai/doc/batch-api)      | [`face`](https://help.hume.ai/models/facial-expression), [`facs`](https://help.hume.ai/models/facial-expression)            | Download results as CSV file                            | [Notebook](./batch-facial-action-coding-system/batch-facial-action-coding-system.ipynb)           |
+| [batch](https://docs.hume.ai/doc/batch-api)      | [`language`](https://help.hume.ai/models/emotional-language), [`sentiment`](https://help.hume.ai/models/emotional-language) | Download results as JSON file                           | [Notebook](./batch-text-sentiment-analysis/batch-text-sentiment-analysis.ipynb)                   |
+| [batch](https://docs.hume.ai/doc/batch-api)      | [`burst`](https://help.hume.ai/models/vocal-bursts), [`prosody`](https://help.hume.ai/models/speech-prosody)                | Webhook callback                                        | [Notebook](./batch-voice-expression/batch-voice-expression.ipynb)                                 |
+| [batch](https://docs.hume.ai/doc/batch-api)      | [`language`,](https://help.hume.ai/models/emotional-language) [`toxicity`](https://help.hume.ai/models/emotional-language)  | Enable email notification                               | [Notebook](./batch-text-toxicity-detection/batch-text-toxicity-detection.ipynb)                   |
+| [batch](https://docs.hume.ai/doc/batch-api)      | [`language`,](https://help.hume.ai/models/emotional-language) [`ner`](https://help.hume.ai/models/emotional-language)       | Submit a file from your local disk                      | [Notebook](./batch-text-entity-recognition/batch-text-entity-recognition.ipynb)                   |
+| [batch](https://docs.hume.ai/doc/batch-api)      | [`prosody`](https://help.hume.ai/models/speech-prosody)                                                                     | Specified language support                              | [Notebook](./batch-specified-language-transcription/batch-specified-language-transcription.ipynb) |
+| [stream](https://docs.hume.ai/doc/streaming-api) | [`facemesh`](https://help.hume.ai/models/facial-expression)                                                                 |                                                         | [Notebook](./stream-anonymized-facemesh/stream-anonymized-facemesh.ipynb)                         |
+| [stream](https://docs.hume.ai/doc/streaming-api) | [`face`](https://help.hume.ai/models/facial-expression)                                                                     | Face identification                                     | [Notebook](./stream-face-expression/stream-face-expression.ipynb)                                 |
+| [stream](https://docs.hume.ai/doc/streaming-api) | [`language`](https://help.hume.ai/models/emotional-language)                                                                | Send raw text over websocket                            | [Notebook](./stream-text-emotion/stream-text-emotion.ipynb)                                       |
+| [stream](https://docs.hume.ai/doc/streaming-api) | [`burst`](https://help.hume.ai/models/vocal-bursts), [`prosody`](https://help.hume.ai/models/speech-prosody)                | Stream media from in memory bytes, reset stream context | [Notebook](./stream-voice-expression/stream-voice-expression.ipynb)                               |
diff --git a/...atch-foreign-language-transcription.ipynb → ...ch-specified-language-transcription.ipynb b/...atch-foreign-language-transcription.ipynb → ...ch-specified-language-transcription.ipynb
@@ -5,7 +5,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Batch API / Foreign Language Transcription\n",
+        "## Batch API / Specified Language Transcription\n",
         "\n",
         "This notebook uses the batch API to analyze emotion in a language of your choice."
       ]
@@ -49,6 +49,7 @@
       ]
     },
     {
+      "attachments": {},
       "cell_type": "markdown",
       "metadata": {},
       "source": [

diff --git a/...reign-language-transcription/utilities.py → ...ified-language-transcription/utilities.py b/...reign-language-transcription/utilities.py → ...ified-language-transcription/utilities.py
diff --git a/hume/models/config/prosody_config.py b/hume/models/config/prosody_config.py
@@ -23,7 +23,7 @@ class ProsodyConfig(ModelConfigBase["ProsodyConfig"]):
             This configuration is only available for the batch API.
         window (Optional[Dict[str, float]]): Sliding window used to chunk audio.
             This dictionary input takes two entries: `length` and `step` representing
-            the width of the window in seconds and the the step size in seconds.
+            the width of the window in seconds and the step size in seconds.
             This configuration is only available for the batch API.
     """