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

feat: Improve dependency management and installation documentation #163

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

erkinalp
Copy link

@erkinalp erkinalp commented Dec 18, 2024

Dependency Management and Installation Documentation Improvements

This PR addresses issue #158 (dependency management) and related discussion #72 (Installation Requirements Documentation) by implementing comprehensive improvements to the project's dependency management and installation documentation.

Changes

1. Dependency Management

  • Updated requirements.txt with specific version requirements
  • Organized dependencies into logical categories
  • Added missing dependencies for new features
  • Added development dependencies for testing and code quality
  • Added system monitoring dependencies (psutil)

2. Package Installation

  • Added pyproject.toml for modern Python packaging
  • Created setup.py with dynamic requirements parsing
  • Implemented proper Python version constraints (3.8-3.11)
  • Added package metadata and configuration

3. System Requirements

  • Added system dependency checks in launch_scientist.py
  • Implemented RAM availability checking
  • Added GPU detection and reporting
  • Improved Python version validation

4. Documentation

  • Created docs/hardware_requirements.md with detailed specifications
  • Created docs/model_configuration.md with model setup guides
  • Added troubleshooting information
  • Documented both minimum and recommended requirements

Testing

  • Verified installation in clean Python 3.11 environment
  • Tested system requirement checks
  • Confirmed proper version constraints
  • Validated all dependencies install correctly

Notes

  • Maintains compatibility with existing Python versions (3.8-3.11)
  • Improves error messages for system requirements
  • Provides clear guidance for different deployment scenarios
  • Includes both cloud and local model configurations

Link to Devin run: https://app.devin.ai/sessions/2ec43d6fe7a84849a348753167e5a895

Closes #158

devin-ai-integration bot and others added 10 commits December 18, 2024 17:36
- Add version specifications for all packages
- Categorize dependencies (LLM APIs, Viz, Core, Optional)
- Add development dependencies
- Include system monitoring tools
- Add helpful comments for clarity

Part of SakanaAI#158

Co-Authored-By: Erkin Alp Güney <[email protected]>
- Add minimum hardware requirements
- Add recommended hardware requirements
- Include detailed explanations for each requirement
- Add notes about GPU requirements
- Document storage requirements breakdown

Part of SakanaAI#158

Co-Authored-By: Erkin Alp Güney <[email protected]>
- Add system requirement verification in launch_scientist.py
- Update requirements.txt with psutil for system monitoring
- Create comprehensive model configuration documentation
- Add hardware requirements documentation
- Update README with improved installation instructions

Co-Authored-By: Erkin Alp Güney <[email protected]>
- Add pyproject.toml with project metadata
- Add setup.py with improved requirements parsing
- Handle comments and version specifiers in requirements.txt

Co-Authored-By: Erkin Alp Güney <[email protected]>
- Remove category-based dependency filtering
- Install all requirements by default
- Fix dependency installation issues

Co-Authored-By: Erkin Alp Güney <[email protected]>
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.

dependencies
1 participant