From a1ef694277ea2da85a242e9a0cce8c73ff05129c Mon Sep 17 00:00:00 2001 From: Chris Gregory <8800689+gregorybchris@users.noreply.github.com> Date: Mon, 24 Jul 2023 11:05:25 -0700 Subject: [PATCH] Update model description links in examples README (#78) --- examples/README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/examples/README.md b/examples/README.md index f36c215f..95175e10 100644 --- 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://dev.hume.ai/reference/start_job) | [`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://dev.hume.ai/reference/start_job) | [`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://dev.hume.ai/reference/start_job) | [`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://dev.hume.ai/reference/start_job) | [`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://dev.hume.ai/reference/start_job) | [`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://dev.hume.ai/reference/start_job) | [`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) | +| API | Models | Extras | Link | +| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| [batch](https://dev.hume.ai/reference/start_job) | [`face`](https://dev.hume.ai/docs/facial-expression), [`facs`](https://dev.hume.ai/docs/facial-expression) | Download results as CSV file | [Notebook](./batch-facial-action-coding-system/batch-facial-action-coding-system.ipynb) | +| [batch](https://dev.hume.ai/reference/start_job) | [`language`](https://dev.hume.ai/docs/emotional-language), [`sentiment`](https://dev.hume.ai/docs/emotional-language) | Download results as JSON file | [Notebook](./batch-text-sentiment-analysis/batch-text-sentiment-analysis.ipynb) | +| [batch](https://dev.hume.ai/reference/start_job) | [`burst`](https://dev.hume.ai/docs/vocal-burst), [`prosody`](https://dev.hume.ai/docs/speech-prosody) | Webhook callback | [Notebook](./batch-voice-expression/batch-voice-expression.ipynb) | +| [batch](https://dev.hume.ai/reference/start_job) | [`language`,](https://dev.hume.ai/docs/emotional-language) [`toxicity`](https://dev.hume.ai/docs/emotional-language) | Enable email notification | [Notebook](./batch-text-toxicity-detection/batch-text-toxicity-detection.ipynb) | +| [batch](https://dev.hume.ai/reference/start_job) | [`language`,](https://dev.hume.ai/docs/emotional-language) [`ner`](https://dev.hume.ai/docs/emotional-language) | Submit a file from your local disk | [Notebook](./batch-text-entity-recognition/batch-text-entity-recognition.ipynb) | +| [batch](https://dev.hume.ai/reference/start_job) | [`prosody`](https://dev.hume.ai/docs/speech-prosody) | Specified language support | [Notebook](./batch-specified-language-transcription/batch-specified-language-transcription.ipynb) | +| [stream](https://dev.hume.ai/docs/streaming-api) | [`facemesh`](https://dev.hume.ai/docs/facial-expression) | | [Notebook](./stream-anonymized-facemesh/stream-anonymized-facemesh.ipynb) | +| [stream](https://dev.hume.ai/docs/streaming-api) | [`face`](https://dev.hume.ai/docs/facial-expression) | Face identification | [Notebook](./stream-face-expression/stream-face-expression.ipynb) | +| [stream](https://dev.hume.ai/docs/streaming-api) | [`language`](https://dev.hume.ai/docs/emotional-language) | Send raw text over WebSocket | [Notebook](./stream-text-emotion/stream-text-emotion.ipynb) | +| [stream](https://dev.hume.ai/docs/streaming-api) | [`burst`](https://dev.hume.ai/docs/vocal-burst), [`prosody`](https://dev.hume.ai/docs/speech-prosody) | Stream media from in memory bytes, reset stream context | [Notebook](./stream-voice-expression/stream-voice-expression.ipynb) |