flashstudio 0.1.2__tar.gz → 0.1.3__tar.gz

{flashstudio-0.1.2 → flashstudio-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flashstudio
-Version: 0.1.2
+Version: 0.1.3
 Summary: Interactive Training & Inference UI for FlashDet — runs on Google Colab
 Author: Gaurav14cs17
 License: Apache-2.0
@@ -20,23 +20,37 @@ 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"
 
-# ⚡ FlashStudio
+<p align="center">
+  <img src="https://raw.githubusercontent.com/FlashVision/FlashStudio/main/assets/logo.png" width="200" alt="FlashStudio Logo">
+</p>
 
-[![PyPI version](https://badge.fury.io/py/flashstudio.svg)](https://pypi.org/project/flashstudio/)
-[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
-[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
+<h1 align="center">FlashStudio</h1>
 
-**Interactive Training & Inference UI for FlashDet** — runs locally or on Google Colab with a Streamlit interface.
+<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"/>
@@ -52,25 +66,69 @@ Requires-Dist: pytest; extra == "dev"
 - 📊 **Dashboard** — Overview with recent training runs from workspace
 - 🚀 **Colab Support** — ngrok tunneling for remote access
 
-## Install
+---
 
-```bash
-pip install flashstudio
-```
+## UI Tour
+
+### Dashboard
+Project overview with key metrics (GPU, Dataset, Model, mAP), pipeline status, quick actions, and recent training runs.
 
-### Install with all dependencies (PyTorch + OpenCV + ngrok)
+<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[full]
+pip install flashstudio
 ```
 
-### Install FlashDet (required for training/inference)
+### Step 2: Install FlashDet (required for training/inference)
 
 ```bash
 pip install git+https://github.com/FlashVision/FlashDet.git
 ```
 
-### Development install
+### Development install (from source)
 
 ```bash
 git clone https://github.com/FlashVision/FlashStudio.git
@@ -78,34 +136,88 @@ cd FlashStudio
 pip install -e .
 ```
 
-## Quick Start
+---
+
+## Usage — Local Machine
 
-### CLI
+### Option 1: CLI
 
 ```bash
 flashstudio --port 8501
 ```
 
-### Python (Streamlit directly)
+### Option 2: Streamlit directly
 
 ```bash
+cd FlashStudio
 streamlit run flashstudio/app.py
 ```
 
-### Python API (Google Colab)
+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()  # Opens ngrok tunnel in Colab, localhost otherwise
+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
+============================================================
 ```
 
-## Google Colab
+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 |
@@ -118,6 +230,8 @@ launch()  # Opens ngrok tunnel in Colab, localhost otherwise
 | FlashDet-X | ~9.0M | Max accuracy / Server |
 | YOLOv8/v9/v10/v11/YOLOX | Varies | General YOLO |
 
+---
+
 ## Architecture
 
 ```
@@ -148,10 +262,40 @@ FlashStudio/
 └── 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

flashstudio-0.1.3/README.md

@@ -0,0 +1,267 @@
+<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
+│   ├── pages/
+│   │   ├── dashboard.py         # Overview + recent training runs
+│   │   ├── data.py              # Dataset upload/download
+│   │   ├── model.py             # Architecture & hyperparameter config
+│   │   ├── training.py          # Training monitor (reads real workspace)
+│   │   ├── export.py            # ONNX export
+│   │   └── inference.py         # 4-step inference pipeline
+│   ├── components/
+│   │   ├── sidebar.py           # Navigation sidebar
+│   │   ├── styles.py            # Custom CSS
+│   │   └── wizard.py            # Step indicator & navigation
+│   └── utils/
+│       └── device.py            # GPU/environment detection
+├── notebooks/
+│   ├── FlashStudio_Train.ipynb
+│   └── FlashStudio_Inference.ipynb
+├── .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

{flashstudio-0.1.2 → flashstudio-0.1.3}/flashstudio/__init__.py

@@ -1,5 +1,5 @@
 """FlashStudio — Interactive Training & Inference UI for FlashDet."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.2"
 
 from flashstudio.launcher import launch  # noqa: F401

flashstudio-0.1.3/flashstudio/app.py

@@ -0,0 +1,123 @@
+"""FlashStudio — Main Streamlit Application."""
+
+import streamlit as st
+
+st.set_page_config(
+    page_title="FlashStudio",
+    page_icon="FS",
+    layout="wide",
+    initial_sidebar_state="expanded",
+)
+
+from flashstudio.components.styles import inject_custom_css  # noqa: E402
+from flashstudio.components.sidebar import render_sidebar  # noqa: E402
+from flashstudio.components.wizard import render_step_indicator, render_navigation  # noqa: E402
+from flashstudio.components.project_manager import (  # noqa: E402
+    get_active_project, render_project_manager_page,
+    save_project_state, list_projects, create_project,
+    load_project_state,
+)
+from flashstudio.pages.dashboard import render_dashboard  # noqa: E402
+from flashstudio.pages.data import render_data_page  # noqa: E402
+from flashstudio.pages.model import render_model_page  # noqa: E402
+from flashstudio.pages.training import render_training_page  # noqa: E402
+from flashstudio.pages.export import render_export_page  # noqa: E402
+from flashstudio.pages.inference import render_inference_page  # noqa: E402
+
+STEPS = [
+    {"id": "dashboard", "label": "Dashboard", "icon": "1"},
+    {"id": "data", "label": "Data", "icon": "2"},
+    {"id": "model", "label": "Model", "icon": "3"},
+    {"id": "training", "label": "Training", "icon": "4"},
+    {"id": "export", "label": "Export", "icon": "5"},
+    {"id": "inference", "label": "Inference", "icon": "6"},
+]
+
+PAGE_RENDERERS = {
+    "dashboard": render_dashboard,
+    "data": render_data_page,
+    "model": render_model_page,
+    "training": render_training_page,
+    "export": render_export_page,
+    "inference": render_inference_page,
+}
+
+
+def main():
+    import traceback as _tb
+
+    inject_custom_css()
+
+    if "current_step" not in st.session_state:
+        st.session_state["current_step"] = 0
+
+    # Ensure critical config values are always initialized
+    from flashstudio.utils import DEFAULTS
+    if not st.session_state.get("save_dir"):
+        st.session_state["save_dir"] = DEFAULTS["save_dir"]
+
+    # Project system — check if user has an active project
+    active_project = get_active_project()
+
+    if active_project is None and not list_projects():
+        # First time user — show project creation
+        _render_first_time_setup()
+        return
+
+    # Load project state once on initial page load
+    if active_project and not st.session_state.get("_project_state_loaded"):
+        load_project_state(active_project["id"])
+        st.session_state["_project_state_loaded"] = True
+
+    if st.session_state.get("show_project_manager"):
+        render_project_manager_page()
+        if st.button("← Back to Workspace", key="back_from_projects"):
+            st.session_state["show_project_manager"] = False
+            st.rerun()
+        return
+
+    render_sidebar()
+    render_step_indicator(STEPS, st.session_state["current_step"])
+
+    current = STEPS[st.session_state["current_step"]]
+
+    try:
+        PAGE_RENDERERS[current["id"]]()
+    except Exception as _e:
+        st.error(f"Error: {_e}")
+        st.code(_tb.format_exc())
+
+    render_navigation(STEPS, st.session_state["current_step"])
+
+    # Auto-save project state on each page render
+    if active_project:
+        save_project_state()
+
+
+def _render_first_time_setup():
+    """Compact first-time project creation."""
+    st.markdown(
+        "<div style='text-align:center; padding:2rem 0 0.5rem;'>"
+        "<b style='font-size:2.5rem;'>FS</b><br>"
+        "<b style='font-size:1.3rem;'>Welcome to FlashStudio</b><br>"
+        "<span style='color:#6B7280;font-size:0.9rem;'>Create your first project to get started</span>"
+        "</div>",
+        unsafe_allow_html=True,
+    )
+
+    with st.container(border=True):
+        col_form, col_info = st.columns([3, 2])
+        with col_form:
+            name = st.text_input("Project Name", placeholder="e.g. Traffic Detection", key="first_project_name")
+            desc = st.text_input("Description (optional)", placeholder="Detect vehicles in traffic footage", key="first_project_desc")
+            if st.button("Create and Start", type="primary", disabled=not name, use_container_width=True):
+                create_project(name, desc)
+                st.rerun()
+        with col_info:
+            st.markdown("#### What's a Project?")
+            for item in ["Dataset management", "Model configuration", "Training runs", "Model exports", "Inference pipeline"]:
+                st.markdown(f'<span style="font-size:0.84rem;color:#4B5563;">{item}</span>', unsafe_allow_html=True)
+
+
+if __name__ == "__main__":
+    main()