Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add hardware requirements to README #103

Merged
merged 26 commits into from
Feb 11, 2025
Merged

Conversation

Kostis-S-Z
Copy link
Member

@Kostis-S-Z Kostis-S-Z commented Feb 10, 2025

What's changing

Add hardware requirements to README.

Closes #102

How to test it

Steps to test the changes:

  1. Run the demo app in your machine / colab without GPU / codespaces
  2. Check that it complies with the hardware requirements

Additional notes for reviewers

Testing it on a 16GB RAM machine in GitHub Codespaces shows that 8GB should be enough.
image

I already...

  • Tested the changes in a working environment to ensure they work as expected
  • Added some tests for any new functionality
  • Updated the documentation (both comments in code and under /docs)

@Kostis-S-Z Kostis-S-Z linked an issue Feb 10, 2025 that may be closed by this pull request
1 task
@Kostis-S-Z Kostis-S-Z requested a review from a team February 10, 2025 16:47
@Kostis-S-Z Kostis-S-Z self-assigned this Feb 10, 2025
@Kostis-S-Z Kostis-S-Z changed the base branch from main to kokoro-pip February 10, 2025 16:49
- OS: Windows, macOS, or Linux
- Python 3.10+ / 3.12+ for Apple M chips
- Minimum RAM: 8 GB
- Disk space: 20 GB minimum
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are the 20GB coming from?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well I thought venv is ~7GB, bartowski/Qwen2.5-7B-Instruct-GGUF/Qwen2.5-7B-Instruct-Q8_0.gguf is also ~8Gb, kokoro is lets say ~1GB, and then some slack space for loading the doc and stuff? 😅 As you see my method is very scientific... do you have any other suggestions?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No suggestions. It just sounds like more than I expected. Is the 7GB venv size with the CUDA version or the CPU version of torch? Anyway, not a blocker

Base automatically changed from kokoro-pip to main February 11, 2025 09:09
@daavoo daavoo merged commit 5f83917 into main Feb 11, 2025
2 checks passed
@daavoo daavoo deleted the 102-mention-system-requirements branch February 11, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention system requirements to host it locally
2 participants