Add docs and support mp3

.github/workflows/ci.yaml

@@ -27,6 +27,12 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Install system dependencies
+        shell: bash
+        run: |
+          sudo apt-get --yes update
+          sudo apt-get --yes install ffmpeg
+
       - name: Install Python dependencies
         shell: bash
         run: |
@@ -97,6 +103,12 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Install system dependencies
+        shell: bash
+        run: |
+          sudo apt-get --yes update
+          sudo apt-get --yes install ffmpeg
+
       - name: Install Python dependencies
         shell: bash
         run: |
@@ -150,7 +162,7 @@ jobs:
         shell: bash
         run: |
           sudo apt-get --yes update
-          sudo apt-get --yes install libasound2-dev libportaudio2
+          sudo apt-get --yes install libasound2-dev libportaudio2 ffmpeg
 
       - name: Install Python dependencies
         shell: bash

.vscode/settings.json

@@ -8,7 +8,7 @@
   "flake8.args": ["--max-line-length", "120"],
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.detectIndentation": true,
-  "editor.formatOnSave": true,
+  // "editor.formatOnSave": true,
   "editor.insertSpaces": true,
   "editor.rulers": [120],
   "isort.args": ["--settings-file", "pyproject.toml"],

docs/batch/batch-job-details.md

@@ -1 +1 @@
-::: hume._batch.batch_job_details.BatchJobDetails
+::: hume._measurement.batch.batch_job_details.BatchJobDetails

docs/batch/batch-job-state.md

@@ -1 +1 @@
-::: hume._batch.batch_job_state.BatchJobState
+::: hume._measurement.batch.batch_job_state.BatchJobState

docs/batch/batch-job-status.md

@@ -1 +1 @@
-::: hume._batch.batch_job_status.BatchJobStatus
+::: hume._measurement.batch.batch_job_status.BatchJobStatus

docs/batch/batch-job.md

@@ -1 +1 @@
-::: hume._batch.batch_job.BatchJob
+::: hume._measurement.batch.batch_job.BatchJob

docs/batch/hume-batch-client.md

@@ -1 +1 @@
-::: hume._batch.hume_batch_client.HumeBatchClient
+::: hume._measurement.batch.hume_batch_client.HumeBatchClient

docs/batch/transcription-config.md

@@ -1 +1 @@
-::: hume._batch.transcription_config.TranscriptionConfig
+::: hume._measurement.batch.transcription_config.TranscriptionConfig

docs/stream/hume-stream-client.md

@@ -1 +1 @@
-::: hume._stream.hume_stream_client.HumeStreamClient
+::: hume._measurement.stream.hume_stream_client.HumeStreamClient

docs/stream/stream-socket.md

@@ -1 +1 @@
-::: hume._stream.stream_socket.StreamSocket
+::: hume._measurement.stream.stream_socket.StreamSocket

docs/voice/hume-voice-client.md

@@ -0,0 +1 @@
+::: hume._voice.hume_voice_client.HumeVoiceClient

docs/voice/microphone-interface.md

@@ -0,0 +1 @@
+::: hume._voice.microphone.microphone_interface.MicrophoneInterface

docs/voice/voice-chat.md

@@ -0,0 +1 @@
+::: hume._voice.models.chats_models.VoiceChat

docs/voice/voice-config.md

@@ -0,0 +1 @@
+::: hume._voice.models.configs_models.VoiceConfig

docs/voice/voice-socket.md

@@ -0,0 +1 @@
+::: hume._voice.voice_socket.VoiceSocket

hume/_voice/voice_socket.py

@@ -83,7 +83,7 @@ async def send_file(self, filepath: Path) -> None:
             filepath (Path): Filepath to the file to send over the socket.
         """
         with filepath.open("rb") as f:
-            segment: AudioSegment = AudioSegment.from_wav(f)
+            segment: AudioSegment = AudioSegment.from_file(f)
             segment = segment.set_frame_rate(self._sample_rate).set_channels(self._num_channels)
             audio_bytes = segment.raw_data
             await self._protocol.send(audio_bytes)

mkdocs.yml

@@ -34,6 +34,12 @@ plugins:
 
 nav:
   - "Home": index.md
+  - "Voice Reference":
+      - "HumeVoiceClient": voice/hume-voice-client.md
+      - "MicrophoneInterface": voice/microphone-interface.md
+      - "VoiceChat": voice/voice-chat.md
+      - "VoiceConfig": voice/voice-config.md
+      - "VoiceSocket": voice/voice-socket.md
   - "Batch Reference":
       - "HumeBatchClient": batch/hume-batch-client.md
       - "BatchJob": batch/batch-job.md

tests/conftest.py

@@ -13,7 +13,7 @@ def eval_data() -> EvalData:
         "burst-amusement-009": f"{base_url}/audio/burst-amusement-009.mp3",
         "prosody-horror-1051": f"{base_url}/audio/prosody-horror-1051.mp3",
         "prosody-noticias": f"{base_url}/audio/prosody-noticias.mp3",
-        "know-any-good-jokes": f"{base_url}/audio/know-any-good-jokes.wav",
+        "know-any-good-jokes": f"{base_url}/audio/know-any-good-jokes.mp3",
         "text-happy-place": f"{base_url}/text/happy.txt",
         "text-obama-news": f"{base_url}/text/obama.txt",
         "three-faces-mediapipe": f"{base_url}/landmarks/three-faces-mediapipe.json",