https://github.com/wearer-lab/transfer-learning-docs
https://github.com/wearer-lab/transfer-learning-docs
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wearer-lab/transfer-learning-docs
- Owner: Wearer-Lab
- Created: 2025-02-27T13:24:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-14T14:33:40.000Z (about 1 year ago)
- Last Synced: 2025-03-14T15:41:53.494Z (about 1 year ago)
- Language: MDX
- Size: 547 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Transfer Learning Documentation
This directory contains the documentation for the Transfer Learning video processing pipeline, built with [Mintlify](https://mintlify.com/).
## Documentation Structure
The documentation is organized into the following sections:
### Getting Started
- [Introduction](/introduction.mdx) - Overview of Transfer Learning
- [Quickstart](/quickstart.mdx) - Quick installation and usage guide
- [Development](/development.mdx) - Guide for developers
### CLI Commands
- [CLI Overview](/cli/overview.mdx) - Overview of all CLI commands
- [Process Video](/cli/process-video.mdx) - Process local video files
- [Generate Guide](/cli/generate-guide.mdx) - Generate guides from processed data
- [Process YouTube](/cli/process-youtube.mdx) - Process YouTube videos
- [YouTube Guide](/cli/youtube-guide.mdx) - Complete YouTube processing pipeline
- [Transcribe](/cli/transcribe.mdx) - Transcribe audio from videos
- [Analyze](/cli/analyze.mdx) - Analyze video content
- [Download](/cli/download.mdx) - Download videos from various sources
- [Utilities](/cli/utilities.mdx) - Utility commands (cleanup, stop, config)
### Advanced Usage
- [Configuration](/advanced/configuration.mdx) - Advanced configuration options
- [Monitoring](/advanced/monitoring.mdx) - Monitoring and metrics collection
- [Optimization](/advanced/optimization.mdx) - Performance optimization techniques
### API Reference
- [Introduction](/api-reference/introduction.mdx) - Introduction to the API
- Core Components documentation
- Guide Generation documentation
- Utilities documentation
## Local Development
To run the documentation locally:
1. Install Mintlify CLI:
```bash
npm i -g mintlify
```
2. Run the development server:
```bash
mintlify dev
```
3. Visit http://localhost:3000 to preview the documentation.
## Package Management
Transfer Learning uses UV as its package manager for faster, more reliable dependency management:
```bash
# Install UV
pip install uv
# Install dependencies with UV
uv pip install -e .
# Install development dependencies
uv pip install -e ".[dev]"
```
## Building and Deploying
The documentation is automatically built and deployed when changes are pushed to the main branch.
## Contributing
To contribute to the documentation:
1. Create a new branch for your changes
2. Make your changes to the relevant MDX files
3. Test your changes locally using `mintlify dev`
4. Submit a pull request
## Documentation Checklist
- [x] Introduction
- [x] CLI Commands Overview
- [x] Process Video Command
- [x] Generate Guide Command
- [x] Process YouTube Command
- [x] YouTube Guide Command
- [x] Transcribe Command
- [x] Analyze Command
- [x] Download Command
- [x] Utility Commands
- [x] Configuration
- [x] Monitoring
- [x] Optimization
- [x] API Reference Introduction
- [ ] Video Processor API
- [ ] Audio Transcriber API
- [ ] Content Analyzer API
- [ ] Frame Extractor API
- [ ] Guide Generator API
- [ ] Downloader API
- [ ] Validation API
- [ ] Path Utilities API
- [ ] Monitoring API