Metadata-Version: 2.4
Name: trackio_ui
Version: 0.1.3
Summary: UI to visualize experiments tracked with trackio
Project-URL: Repository, https://github.com/ssslakter/trackio_ui
Author-email: Slava <67190162+Ssslakter@users.noreply.github.com>
License: MIT License
        
        Copyright (c) 2026 Slava
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: deep-learning,experiment-tracking,training,visualization
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Requires-Dist: black
Requires-Dist: click
Requires-Dist: monsterui
Requires-Dist: orjson
Requires-Dist: pandas
Requires-Dist: polars
Requires-Dist: pyarrow
Requires-Dist: trackio[gpu]
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: jupyter; extra == 'dev'
Requires-Dist: python-semantic-release; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# trackio-ui
[![PyPI version](https://img.shields.io/pypi/v/trackio-ui.svg)](https://pypi.org/project/trackio-ui/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![GitHub stars](https://img.shields.io/github/stars/ssslakter/trackio_ui?style=social)](https://github.com/ssslakter/trackio_ui)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/trackio-ui)

A simple UI for the trackio dashboard, written in **FastHTML**. The primary reason for creating this was the poor performance of the Gradio frontend for trackio.

Original Trackio repository: https://github.com/gradio-app/trackio

With this UI, you can configure the maximum number of data points for graphs to prevent slow communication and rendering.

## Installation
```sh
pip install trackio-ui
```

You can also install the latest version using git:

```sh
pip install "trackio-ui @ git+https://github.com/ssslakter/trackio_ui.git"
```

## Getting Started
To start the local trackio-ui server, run the following command:
```sh
trackio-ui --project "my-project" 
```

## Highlights
- Fast dashboard workflow for local experiments.
- Switch between dark and light themes.
- Preview charts for detailed inspection.
- Manage runs from the table, including deleting selected runs.
- Inspect run hyperparameters.

### Screenshots

#### Dashbord showing runs logged with trackio
<img src="images/preview.png" width="700" alt="Dashbord with trackio runs">

#### Runs Table and Hyperparameters
<img src="images/table.png" width="700" alt="Runs table with delete action and hyperparameter columns">

#### Preview graph and vary the time-scale
<img src="images/dark-theme.png" width="700" alt="Preview of large graph in the dashboard">




## Configuration
By default, the app looks for Trackio projects in the `~/.cache/huggingface/trackio` folder, but you can change this location by setting the `TRACKIO_ROOT` environment variable. The project names you use in the URL must match your Trackio project names. You can set the default project either by providing the `--project` argument in the CLI or by setting the `TRACKIO_DEFAULT_PROJECT` environment variable. The default port for the app is `8000`.

## Contributing

Contributions are very welcome. I would be glad if you open issues or create PRs.

If you found a bug, have a feature request, or want to improve the UI/UX, please open an issue first so we can align on the direction.

For pull requests:
- Keep changes focused and small when possible.
- Include screenshots for UI updates.
- Reference related issues if applicable.
