Description:

• Include requirements.txt.
• Add setup*. files to build a package.
• Create a folder simple_diarizer to store source code.
• Create Github Workflow to publish the package.

How to test:

• Run command pip install .
• Outside project folder type python and from simple_diarizer import diarizer

Notes:

• Cannot use python 3.10.x yet

Source code to test:

from simple_diarizer.utils import (convert_wavfile, download_youtube_wav)

from simple_diarizer.diarizer import Diarizer
import tempfile

YOUTUBE_ID = "HyKmkLEtQbs"

with tempfile.TemporaryDirectory() as outdir:
    yt_file = download_youtube_wav(YOUTUBE_ID, outdir)

    wav_file = convert_wavfile(yt_file, f"{outdir}/{YOUTUBE_ID}_converted.wav")

    print(f"wav file: {wav_file}")

    diar = Diarizer(
        embed_model='ecapa', # supported types: ['xvec', 'ecapa']
        cluster_method='sc', # supported types: ['ahc', 'sc']
        window=1.5, # size of window to extract embeddings (in seconds)
        period=0.75 # hop of window (in seconds)
    )

    NUM_SPEAKERS = 2

    segments = diar.diarize(wav_file, 
                            num_speakers=NUM_SPEAKERS,
                            outfile=f"{outdir}/{YOUTUBE_ID}.rttm")

    print(segments)     

I am using macOS and I am getting error "[Errno 30] Read-only file system: 'pretrained_models'" From what I can tell, the pretrained models are being fetched if you do not have them.

However, the save location is the root directory which is read-only. This is where I believe is the target directory "./pretrained_model_checkpoints"

Is there another location that can be used that can be used?

PythonKit/Python.swift:706: Fatal error: 'try!' expression unexpectedly raised an error: Python exception: [Errno 30] Read-only file system: 'pretrained_models' Traceback: File "/Users/wedwards/Documents/Development/A_PythonKit_Test/A_PythonKit_Test/Simple Diarizer.py", line 42, in diar = Diarizer( File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/simple_diarizer/diarizer.py", line 48, in init self.embed_model = EncoderClassifier.from_hparams( File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/speechbrain/pretrained/interfaces.py", line 342, in from_hparams hparams_local_path = fetch( File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/speechbrain/pretrained/fetching.py", line 86, in fetch savedir.mkdir(parents=True, exist_ok=True) File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/pathlib.py", line 1179, in mkdir self.parent.mkdir(parents=True, exist_ok=True) File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/pathlib.py", line 1175, in mkdir self._accessor.mkdir(self, mode)

2022-11-11 13:14:00.531470-0500 A_PythonKit_Test[69382:7584330] PythonKit/Python.swift:706: Fatal error: 'try!' expression unexpectedly raised an error: Python exception: [Errno 30] Read-only file system: 'pretrained_models' Traceback: File "/Users/wedwards/Documents/Development/A_PythonKit_Test/A_PythonKit_Test/Simple Diarizer.py", line 42, in diar = Diarizer( File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/simple_diarizer/diarizer.py", line 48, in init self.embed_model = EncoderClassifier.from_hparams( File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/speechbrain/pretrained/interfaces.py", line 342, in from_hparams hparams_local_path = fetch( File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/speechbrain/pretrained/fetching.py", line 86, in fetch savedir.mkdir(parents=True, exist_ok=True) File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/pathlib.py", line 1179, in mkdir self.parent.mkdir(parents=True, exist_ok=True) File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/pathlib.py", line 1175, in mkdir self._accessor.mkdir(self, mode)

The current release prevents use of Python 3.10 and requires specific versions of Beautiful Soup and PyTube.

I've forked the repo to overcome these version limitations and it's working for me. I haven't made a pull request, however, as your repo doesn't have tests and I don't know whether there is a use case which would be broken by my changes.

Can you please remove these version limitations if they're not needed?

Thanks for the repo - it's effective and much easier to use than SpeechBrain.

running a demo on google co-lab i am getting the following error, any idea how to resolve this,

File "/root/anaconda3/envs/simple/lib/python3.8/site-packages/speechbrain/pretrained/fetching.py", line 116, in fetch fetched_file = huggingface_hub.cached_download(url, use_auth_token) TypeError: cached_download() takes 1 positional argument but 2 were given

Hi there!

When running the following code in Python 3.7 on a fresh conda environment in Ubuntu 22.04

from simple_diarizer.diarizer import Diarizer

diar = Diarizer(
                    embed_model='xvec', # 'xvec' and 'ecapa' suported
                    cluster_method='sc' # 'ahc' and 'sc' supported
                )

I get the following error:

<ipython-input-3-286690ce0195> in <module>
      1 diar = Diarizer(
      2                     embed_model='xvec', # 'xvec' and 'ecapa' suported
----> 3                     cluster_method='sc' # 'ahc' and 'sc' supported
      4                 )

~/anaconda3/envs/test/lib/python3.7/site-packages/simple_diarizer/diarizer.py in __init__(self, embed_model, cluster_method, window, period)
     44             self.embed_model = EncoderClassifier.from_hparams(source="speechbrain/spkrec-xvect-voxceleb",
     45                                                               savedir="pretrained_models/spkrec-xvect-voxceleb",
---> 46                                                               run_opts=self.run_opts)
     47         if embed_model == 'ecapa':
     48             self.embed_model = EncoderClassifier.from_hparams(source="speechbrain/spkrec-ecapa-voxceleb",

~/anaconda3/envs/test/lib/python3.7/site-packages/speechbrain/pretrained/interfaces.py in from_hparams(cls, source, hparams_file, pymodule_file, overrides, savedir, use_auth_token, **kwargs)
    349         # Load the modules:
    350         with open(hparams_local_path) as fin:
--> 351             hparams = load_hyperpyyaml(fin, overrides)
    352 
    353         # Pretraining:

~/anaconda3/envs/test/lib/python3.7/site-packages/hyperpyyaml/core.py in load_hyperpyyaml(yaml_stream, overrides, overrides_must_match)
    187 
    188     # Remove items that start with "__"
--> 189     removal_keys = [k for k in hparams.keys() if k.startswith("__")]
    190     for key in removal_keys:
    191         del hparams[key]

AttributeError: 'str' object has no attribute 'keys'

Hi @cvqluu, this project is amazing, thanks for sharing.

I have some experience in packaging projects in Python.

What do you think I make these items on your to-do list?

• Add to PyPi (make pip installable)
• requirements.txt

If you authorize me, I will start doing this now and submit pull requests for your review and approval.

Tested on local machine using:

pip install --user git+https://github.com/cvqluu/simple_diarizer.git@cvqluu-ipython-reqs

Fix for https://github.com/cvqluu/simple_diarizer/issues/12

Bumps ipython from 7.30.1 to 7.31.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

The current package (0.0.12 on PyPI) cannot run without IPython, but this is missing from requirements.txt

Steps to reproduce (outside of a Jupyter notebook):

pip install simple-diarizer

# index.py
from simple_diarizer.diarizer import Diarizer

Output:

File "[redacted]\index.py", line 1, in <module>
    from simple_diarizer.diarizer import Diarizer
File "[redacted]\lib\site-packages\simple_diarizer\diarizer.py", line 13, in <module>
    from .utils import check_wav_16khz_mono, convert_wavfile
File "[redacted]\lib\site-packages\simple_diarizer\utils.py", line 8, in <module>
    from IPython.display import Audio, display
ModuleNotFoundError: No module named 'IPython'

While running through your code example, testing the workflow on a different audio file produced the following output:

C:\Users\xxx\Miniconda3\envs\simple_diarizer_env\lib\site-packages\IPython\lib\display.py:187: RuntimeWarning: invalid value encountered in divide
  scaled = data / normalization_factor * 32767
---------------------------------------------------------------------------
error                                     Traceback (most recent call last)
Cell In [18], line 1
----> 1 waveplot_perspeaker(signal, fs, segments)

File ~\Miniconda3\envs\simple_diarizer_env\lib\site-packages\simple_diarizer\utils.py:166, in waveplot_perspeaker(signal, fs, segments)
    164 if "words" in seg:
    165     pprint(seg["words"])
--> 166 display(Audio(speech, rate=fs))
    167 print("=" * 40 + "\n")

File ~\Miniconda3\envs\simple_diarizer_env\lib\site-packages\IPython\lib\display.py:130, in Audio.__init__(self, data, filename, url, embed, rate, autoplay, normalize, element_id)
    128 if rate is None:
    129     raise ValueError("rate must be specified when data is a numpy array or list of audio samples.")
--> 130 self.data = Audio._make_wav(data, rate, normalize)

File ~\Miniconda3\envs\simple_diarizer_env\lib\site-packages\IPython\lib\display.py:162, in Audio._make_wav(data, rate, normalize)
    160 waveobj.setsampwidth(2)
    161 waveobj.setcomptype('NONE','NONE')
--> 162 waveobj.writeframes(scaled)
    163 val = fp.getvalue()
    164 waveobj.close()

File ~\Miniconda3\envs\simple_diarizer_env\lib\wave.py:437, in Wave_write.writeframes(self, data)
    436 def writeframes(self, data):
--> 437     self.writeframesraw(data)
    438     if self._datalength != self._datawritten:
    439         self._patchheader()

File ~\Miniconda3\envs\simple_diarizer_env\lib\wave.py:426, in Wave_write.writeframesraw(self, data)
    424 if not isinstance(data, (bytes, bytearray)):
    425     data = memoryview(data).cast('B')
--> 426 self._ensure_header_written(len(data))
    427 nframes = len(data) // (self._sampwidth * self._nchannels)
    428 if self._convert:

File ~\Miniconda3\envs\simple_diarizer_env\lib\wave.py:467, in Wave_write._ensure_header_written(self, datasize)
    465 if not self._framerate:
    466     raise Error('sampling rate not specified')
--> 467 self._write_header(datasize)

File ~\Miniconda3\envs\simple_diarizer_env\lib\wave.py:479, in Wave_write._write_header(self, initlength)
    477 except (AttributeError, OSError):
    478     self._form_length_pos = None
--> 479 self._file.write(struct.pack('<L4s4sLHHLLHH4s',
    480     36 + self._datalength, b'WAVE', b'fmt ', 16,
    481     WAVE_FORMAT_PCM, self._nchannels, self._framerate,
    482     self._nchannels * self._framerate * self._sampwidth,
    483     self._nchannels * self._sampwidth,
    484     self._sampwidth * 8, b'data'))
    485 if self._form_length_pos is not None:
    486     self._data_length_pos = self._file.tell()

error: argument out of range

Any ideas what the issue could be? It works fine on other audio files, and everything up to this point seems to run without error.