Metadata-Version: 2.4
Name: researchpad
Version: 0.1.0
Summary: AI-powered autonomous ML experimentation companion
Author: ResearchPad Contributors
License: Apache-2.0
Project-URL: Homepage, https://github.com/researchpad/researchpad
Project-URL: Documentation, https://researchpad.github.io/researchpad
Project-URL: Repository, https://github.com/researchpad/researchpad
Project-URL: Issues, https://github.com/researchpad/researchpad/issues
Keywords: machine-learning,experiments,ai,automation,ml-ops
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.1; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.5; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
Dynamic: license-file

# ResearchPad

AI-powered autonomous ML experimentation companion.

ResearchPad provides a web UI and cursor commands for running iterative ML experiment loops. It tracks experiments, manages research artifacts, performs debug analysis, and surfaces insights -- all driven by AI coding agents.

## Quick Start

```bash
pip install researchpad
researchpad init
researchpad runserver
# Open http://localhost:8888
```

## Features

- **Dashboard** -- Real-time experiment progress, summary cards, activity feed
- **Experiments** -- Full history with sorting, filtering, git diffs, metric comparison
- **Research** -- Structured artifacts from papers, Kaggle, blogs, and GitHub
- **Debug** -- Deep outlier and error analysis with targeted experiment prompts
- **Insights** -- Theme clustering, learnings journal, diminishing returns detection
- **Dark/Light Mode** -- System-aware with manual toggle
- **Live Updates** -- WebSocket-based real-time refresh
- **Keyboard Shortcuts** -- Press `?` for the full list

## Cursor Commands

| Command | Description |
|---------|-------------|
| `/experiment` | Run autonomous experiment loops to improve your pipeline |
| `/research` | Research a topic and produce structured artifacts |
| `/debug` | Analyze model failures and outliers |
| `/explain` | Explain a specific experiment in detail |

## Requirements

- Python >= 3.10
- Node.js >= 18 (for the UI server)

## Documentation

Full documentation: [https://researchpad.github.io/researchpad](https://researchpad.github.io/researchpad)

## Development

```bash
git clone https://github.com/researchpad/researchpad.git
cd researchpad
make install
make dev
```

## License

Apache 2.0 -- see [LICENSE](LICENSE) for details.
