flashstudio 0.1.2__tar.gz → 0.1.4__tar.gz

flashstudio-0.1.4/PKG-INFO

@@ -0,0 +1,371 @@
+Metadata-Version: 2.4
+Name: flashstudio
+Version: 0.1.4
+Summary: Interactive Training & Inference UI for FlashDet — runs on Google Colab
+Author: Gaurav14cs17
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/FlashVision/FlashStudio
+Project-URL: Repository, https://github.com/FlashVision/FlashStudio
+Keywords: object-detection,flashdet,training,inference,ui,colab
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: streamlit>=1.28.0
+Requires-Dist: plotly>=5.0
+Requires-Dist: pandas>=1.5
+Requires-Dist: pillow>=9.0
+Requires-Dist: numpy>=1.21
+Requires-Dist: pyngrok>=6.0
+Requires-Dist: opencv-python>=4.5
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: flashdet
+Provides-Extra: full
+Requires-Dist: pyngrok>=6.0; extra == "full"
+Requires-Dist: torch>=2.0; extra == "full"
+Requires-Dist: opencv-python>=4.5; extra == "full"
+Requires-Dist: flashdet[export]; extra == "full"
+Provides-Extra: colab
+Requires-Dist: pyngrok>=6.0; extra == "colab"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/FlashVision/FlashStudio/main/assets/logo.png" width="200" alt="FlashStudio Logo">
+</p>
+
+<h1 align="center">FlashStudio</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/flashstudio/"><img src="https://badge.fury.io/py/flashstudio.svg" alt="PyPI version"></a>
+  <img src="https://img.shields.io/badge/python-3.9+-blue.svg?logo=python&logoColor=white" alt="Python 3.9+">
+  <img src="https://img.shields.io/badge/Streamlit-UI-FF4B4B?logo=streamlit&logoColor=white" alt="Streamlit">
+  <img src="https://img.shields.io/badge/FlashDet-Powered-00CCFF?logo=lightning&logoColor=white" alt="FlashDet">
+  <img src="https://img.shields.io/badge/License-Apache%202.0-green.svg" alt="License">
+</p>
+
+<p align="center">
+  <b>Interactive Training & Inference UI for FlashDet — runs locally or on Google Colab with a Streamlit interface.</b>
+</p>
+
+<p align="center">
+  <img src="docs/mockups/flashstudio_streamlit_mockup.png" width="800" alt="FlashStudio UI"/>
+</p>
+
+## Features
+
+- 🏋️ **Training Dashboard** — Real-time monitoring with live loss curves, per-epoch visualizations, GT verification
+- 🧠 **Model Config** — All 6 FlashDet sizes + YOLOv8/v9/v10/v11/YOLOX with accurate params
+- 🔍 **Inference Pipeline** — 4-step wizard: Model → Data → Zone → Run (17 solutions, 6 trackers)
+- 📤 **Export** — ONNX export with FP16 auto-generated weights
+- 📦 **Data** — Native `flashdet download` datasets + custom upload (COCO/VOC/YOLO formats)
+- 📊 **Dashboard** — Overview with recent training runs from workspace
+- 🚀 **Colab Support** — ngrok tunneling for remote access
+
+---
+
+## UI Tour
+
+### Dashboard
+Project overview with key metrics (GPU, Dataset, Model, mAP), pipeline status, quick actions, and recent training runs.
+
+<p align="center">
+  <img src="demos/01_dashboard.gif" width="800" alt="Dashboard"/>
+</p>
+
+### Data Management
+Upload datasets (ZIP/TAR), download from `flashdet` registry, preview images with navigation, and verify annotations.
+
+<p align="center">
+  <img src="demos/02_data.gif" width="800" alt="Data Management"/>
+</p>
+
+### Model Configuration
+Choose from 6 FlashDet sizes + YOLO variants. Configure hyperparameters, augmentations, and advanced settings (memory optimization, distributed training).
+
+<p align="center">
+  <img src="demos/03_model.gif" width="800" alt="Model Configuration"/>
+</p>
+
+### Training
+Create experiments, launch training with preflight checks, and monitor runs with real-time curves, visualizations, ground truth, logs, and file browser.
+
+<p align="center">
+  <img src="demos/04_training.gif" width="800" alt="Training"/>
+</p>
+
+### Export
+Export trained models to ONNX format with configurable opset, image size, and dynamic batching. Auto-detects saved weights from training.
+
+<p align="center">
+  <img src="demos/05_export.gif" width="800" alt="Export"/>
+</p>
+
+### Inference
+Full inference pipeline with 17 built-in solutions (object counting, speed estimation, heatmaps, security alarms, etc.). Interactive zone drawing with Polygon, Rectangle, and Line tools.
+
+<p align="center">
+  <img src="demos/06_inference.gif" width="800" alt="Inference"/>
+</p>
+
+---
+
+## Installation
+
+### Step 1: Install FlashStudio
+
+```bash
+pip install flashstudio
+```
+
+### Step 2: Install FlashDet (required for training/inference)
+
+```bash
+pip install git+https://github.com/FlashVision/FlashDet.git
+```
+
+### Development install (from source)
+
+```bash
+git clone https://github.com/FlashVision/FlashStudio.git
+cd FlashStudio
+pip install -e .
+```
+
+---
+
+## Usage — Local Machine
+
+### Option 1: CLI
+
+```bash
+flashstudio --port 8501
+```
+
+### Option 2: Streamlit directly
+
+```bash
+cd FlashStudio
+streamlit run flashstudio/app.py
+```
+
+Then open **http://localhost:8501** in your browser.
+
+---
+
+## Usage — Google Colab
+
+### Step 1: Install packages
+
+```python
+!pip install flashstudio
+!pip install git+https://github.com/FlashVision/FlashDet.git
+```
+
+### Step 2: Get ngrok token (free, one-time setup)
+
+FlashStudio uses [ngrok](https://ngrok.com) to create a public URL for the Streamlit UI in Colab.
+
+1. **Sign up** (free): https://dashboard.ngrok.com/signup
+2. **Get your auth token**: https://dashboard.ngrok.com/get-started/your-authtoken
+3. Copy the token (looks like `2xAbC1234_something...`)
+
+### Step 3: Launch
+
+```python
+from flashstudio import launch
+
+# Pass your ngrok token
+launch(ngrok_token="YOUR_NGROK_TOKEN_HERE")
+```
+
+Or set it as an environment variable:
+
+```python
+import os
+os.environ["NGROK_TOKEN"] = "YOUR_NGROK_TOKEN_HERE"
+
+from flashstudio import launch
+launch()
+```
+
+### Step 4: Open the URL
+
+After launching, you'll see output like:
+
+```
+============================================================
+  FlashStudio is running!
+  Local:  http://localhost:8501
+  Public: https://abc123.ngrok-free.app
+============================================================
+```
+
+Click the **Public URL** to open FlashStudio in a new tab.
+
+---
+
+## Google Colab Notebooks (Ready to Use)
+
+| Notebook | Description | Link |
+|----------|-------------|------|
+| Training | Train FlashDet models | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/FlashVision/FlashStudio/blob/main/notebooks/FlashStudio_Train.ipynb) |
+| Inference | Run detection on images/video | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/FlashVision/FlashStudio/blob/main/notebooks/FlashStudio_Inference.ipynb) |
+
+---
+
+## Supported Models
+
+| Model | Params | Best For |
+|-------|--------|----------|
+| FlashDet-Pico | ~298K | Edge / MCU |
+| FlashDet-Nano | ~790K | Embedded / IoT |
+| FlashDet-Small | ~1.8M | General purpose |
+| FlashDet-Medium | ~3.6M | High accuracy |
+| FlashDet-Large | ~5.8M | High accuracy |
+| FlashDet-X | ~9.0M | Max accuracy / Server |
+| YOLOv8/v9/v10/v11/YOLOX | Varies | General YOLO |
+
+---
+
+## Architecture
+
+```
+FlashStudio/
+├── flashstudio/
+│   ├── __init__.py                  # Package init + launch() export
+│   ├── app.py                       # Main Streamlit app (wizard flow)
+│   ├── launcher.py                  # Colab/local launcher with ngrok
+│   ├── cli.py                       # CLI entrypoint
+│   ├── constants.py                 # Centralized constants (paths, defaults, models)
+│   │
+│   ├── pages/                       # Each page is a sub-package
+│   │   ├── dashboard/
+│   │   │   ├── page.py              # Main dashboard render
+│   │   │   ├── pipeline_status.py   # Pipeline status cards
+│   │   │   └── recent_runs.py       # Recent training runs table
+│   │   ├── data/
+│   │   │   ├── page.py              # Main data page render
+│   │   │   ├── upload.py            # Upload tab (ZIP/TAR + class config)
+│   │   │   ├── download.py          # Download tab (quick start + registries)
+│   │   │   ├── preview.py           # Preview tab (image grid + annotations)
+│   │   │   ├── verify.py            # Verify tab (dataset validation)
+│   │   │   └── helpers.py           # Shared helpers (extract, detect, convert)
+│   │   ├── model/
+│   │   │   ├── page.py              # Main model page render
+│   │   │   ├── architecture.py      # Architecture tab (FlashDet/YOLO selection)
+│   │   │   ├── hyperparams.py       # Hyperparameters tab
+│   │   │   ├── augmentation.py      # Augmentation tab
+│   │   │   ├── advanced.py          # Advanced tab (memory, distributed)
+│   │   │   └── summary.py           # Config summary bar + YAML save/load
+│   │   ├── training/
+│   │   │   ├── page.py              # Main training page render
+│   │   │   ├── _common.py           # Shared utilities (_get_save_dir)
+│   │   │   ├── launch/              # Launch sub-package
+│   │   │   │   ├── tab.py           # Launch tab entry point
+│   │   │   │   ├── preflight.py     # Pre-flight checks
+│   │   │   │   ├── runner.py        # FlashDet Trainer subprocess
+│   │   │   │   ├── controls.py      # Start/stop/pause/resume buttons
+│   │   │   │   └── dialogs.py       # Clean/resume/config dialogs
+│   │   │   └── monitor/             # Monitor sub-package
+│   │   │       ├── tab.py           # Monitor tab entry point
+│   │   │       ├── run_meta.py      # Run metadata extraction
+│   │   │       ├── parsers.py       # CSV/log parsing
+│   │   │       ├── dashboard.py     # Run dashboard + metrics
+│   │   │       ├── curves.py        # Plotly training curves
+│   │   │       ├── visualizations.py # Epoch visualizations
+│   │   │       ├── gt_verification.py # Ground truth verification
+│   │   │       ├── log_viewer.py    # Full log viewer
+│   │   │       └── checkpoints.py   # File browser + checkpoints
+│   │   ├── export/
+│   │   │   └── page.py              # Export page (ONNX/TorchScript)
+│   │   └── inference/
+│   │       ├── page.py              # Main inference page render
+│   │       ├── model_tab.py         # Model selection tab
+│   │       ├── data_tab.py          # Data input tab (images/video/RTSP)
+│   │       ├── solution_tab.py      # Solution selection + zone drawing
+│   │       ├── run_tab.py           # Run tab + results display
+│   │       ├── detection.py         # Detection utilities (real + demo)
+│   │       └── video.py             # Video/image inference runners
+│   │
+│   ├── components/
+│   │   ├── sidebar.py               # Navigation sidebar
+│   │   ├── styles.py                # Custom CSS + UI helpers
+│   │   ├── wizard.py                # Step indicator + navigation
+│   │   ├── project_manager.py       # Project CRUD + state persistence
+│   │   └── zone_drawer/             # Interactive canvas zone drawing
+│   │
+│   └── utils/
+│       ├── __init__.py              # Shared helpers (defaults, state, flash)
+│       ├── device.py                # GPU/environment detection
+│       ├── jobs.py                  # Background process tracking
+│       ├── filesystem.py            # Directory size/listing utilities
+│       ├── config.py                # Training config build/save/load
+│       └── training_hooks.py        # FlashDet training callbacks
+│
+├── tests/                           # Pytest test suite
+│   ├── conftest.py                  # Shared fixtures
+│   ├── test_constants.py            # Constants validation
+│   ├── test_cli.py                  # CLI tests
+│   ├── test_utils/                  # Utils sub-package tests
+│   │   ├── test_init.py
+│   │   ├── test_device.py
+│   │   ├── test_filesystem.py
+│   │   ├── test_config.py
+│   │   └── test_jobs.py
+│   ├── test_pages/                  # Page logic tests
+│   │   └── test_training_parsers.py
+│   └── test_components/
+│       └── test_project_manager.py
+│
+├── .github/workflows/ci.yml        # GitHub Actions CI
+├── notebooks/
+├── .streamlit/config.toml
+├── pyproject.toml
+└── README.md
+```
+
+---
+
+## Troubleshooting
+
+### `ModuleNotFoundError: No module named 'pyngrok'`
+
+```bash
+pip install --upgrade flashstudio
+```
+
+### ngrok authentication error (`ERR_NGROK_4018`)
+
+You need an ngrok auth token. Get one free at:
+https://dashboard.ngrok.com/get-started/your-authtoken
+
+Then pass it to `launch(ngrok_token="your_token")`.
+
+### Streamlit port already in use
+
+```bash
+# Kill existing Streamlit processes
+pkill -f "streamlit run"
+
+# Then restart
+flashstudio --port 8501
+```
+
+---
+
+## Requirements
+
+- Python >= 3.9
+- FlashDet (`pip install git+https://github.com/FlashVision/FlashDet.git`)
+- ngrok account (free) for Google Colab usage
+- GPU recommended for training (T4 or better)
+
+## License
+
+Apache-2.0