Skip to content

Add automated PolyGen model download tools and fix documentation - Fixes #588 #641

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nsrawat0333
Copy link

Summary

This PR addresses Issue #588 by providing comprehensive solutions for PolyGen pre-trained model accessibility and resolving user confusion about file names and download methods.

Changes Made

🔧 New Download Tools

  • polygen/download_polygen_models.py: Automated download script with:
    • HTTP download with progress tracking
    • Automatic tar.gz extraction
    • Model file verification
    • Cross-platform compatibility
    • Error handling and retry logic

📚 Enhanced Documentation

  • Updated polygen/README.md with:
    • Multiple download methods (Python script, gsutil, wget)
    • Clear file naming explanations
    • Troubleshooting section
    • Step-by-step instructions

📦 Dependencies

  • polygen/requirements-download.txt: Minimal dependencies for download functionality

Problem Solved

  • Before: Users confused about PolyGen model file names and download methods
  • After: Clear automated download system with comprehensive documentation

Key Features

  • 🚀 One-command download: python download_polygen_models.py
  • 📊 Progress tracking: Real-time download progress bars
  • 🔍 File verification: Ensures download integrity
  • 🛠️ Multiple options: Script, gsutil, or manual download methods
  • 📖 Clear docs: Eliminates confusion mentioned in Issue where is the face_model.tar and the vertices_model.tar #588

Testing

  • ✅ Tested download functionality
  • ✅ Verified tar.gz extraction
  • ✅ Confirmed file structure
  • ✅ Cross-platform compatibility

Related Issues

Fixes #588 - PolyGen model download accessibility

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Ready for review and testing! 🚀

- Update aiohttp to address potential security vulnerabilities
- Maintains compatibility with existing codebase
- Addresses dependency security recommendations
…-deepmind#588

- Create download_polygen_models.py script for automated model downloading
- Add comprehensive documentation for pre-trained model access
- Provide multiple download methods (Python script, gsutil, wget)
- Add troubleshooting section addressing Issue google-deepmind#588 confusion
- Create requirements-download.txt for download dependencies

Addresses Issue google-deepmind#588: 'where is the face_model.tar and the vertices_model.tar'

The issue was caused by:
1. Unclear documentation about model file locations
2. Confusion about file names (face_model.tar.gz vs face_model.tar)
3. No clear download instructions outside of Colab environment
4. Missing troubleshooting guidance

Solutions provided:
1. Python download script with progress bars and verification
2. Clear documentation of all download methods
3. Correct file names and locations specified
4. Comprehensive troubleshooting section
5. Multiple fallback options for different environments

Users can now easily access PolyGen pre-trained models using:
- Automated Python script (recommended)
- Manual gsutil commands
- Direct HTTP downloads
- Built-in verification and error handling
@polarbe
Copy link

polarbe commented Aug 10, 2025 via email

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.

where is the face_model.tar and the vertices_model.tar
2 participants