# Meeting Minutes

This is a local recording, transcription, and summarisation script that listens to your meeting and generates a summary. This is completely offline, to protect your data privacy.

## Live Version

Gotta run it locally. Sorry!

1. Install Ollama, pull `llama3:8b`
2. Install `uv`.
3. Run `uvx python@3.12 whisperx` to install whisperx
4. Run `uvx python@3.12 main.py`.

### Diarization

To download the models needed for diarization, you need to create a Hugging Face account. Then you should agree to the terms to access these two models:

1. https://huggingface.co/pyannote/segmentation-3.0
2. https://huggingface.co/pyannote/speaker-diarization-3.1

Uncomment the `--hf_token` line and provide your Hugging Face token. This token needs read permissions for gated public repositories you have access to.

Once you have run the script with this token at least once, you can remove your token and the script should work as normal.

## Feedback and Bugs

If you have feedback or a bug report, please feel free to open a GitHub issue!

## Contributing

If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our [contributing guidelines](CONTRIBUTING.md) first.

## Code of Conduct

Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).

## License

This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).

Copyright held by Naomi Carrigan.

## Contact

We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`.