Skip to content

Commit d039dce

Browse files
authored
Merge pull request #1 from walkerbdev/docs/add-problem-statement
Add problem statement and ecosystem sections to docs
2 parents a40dae4 + fa7aaf7 commit d039dce

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,34 @@
1212

1313
---
1414

15+
## 🎯 The Problem
16+
17+
Modern data science and machine learning workflows involve countless experiments—tweaking hyperparameters, adjusting data preprocessing, testing different architectures, updating dependencies, modifying code. **Every change produces different results**, but tracking and comparing these variations manually becomes overwhelming:
18+
19+
- 📋 Which parameters, environment, or code version led to that breakthrough result last week?
20+
- 🔍 How does changing the learning rate affect convergence across multiple runs?
21+
- 📊 What's the actual performance difference between model architectures?
22+
- 🤔 Which preprocessing steps improved accuracy by 2%?
23+
- 🔧 Did upgrading that dependency break model performance?
24+
- 💻 What code changes caused the regression?
25+
26+
Without systematic tracking of **parameters, metrics, code changes, dependencies, and environment**, you're flying blind—relying on scattered notes, terminal output, and memory. **Artifacta solves this** by automatically capturing experiments, configurations, code versions, and artifacts in one place with intelligent visualization.
27+
28+
---
29+
30+
## 🌍 Ecosystem & Alternatives
31+
32+
Artifacta is part of a growing ecosystem of experiment tracking tools. Popular alternatives include:
33+
34+
- [**MLflow**](https://mlflow.org/) - Open-source platform from Databricks for ML lifecycle management
35+
- [**Weights & Biases**](https://wandb.ai/) - Cloud-first experiment tracking with team collaboration features
36+
- [**Neptune.ai**](https://neptune.ai/) - Metadata store for MLOps with extensive integrations
37+
- [**Comet ML**](https://www.comet.com/) - ML platform with experiment tracking and model production monitoring
38+
39+
**Why Artifacta?** We focus on **automatic visualization discovery**, **domain-agnostic tracking** (not just ML), and **simple self-hosting** with a pre-built UI. No heavy dependencies, no mandatory cloud services—just install and start tracking.
40+
41+
---
42+
1543
## ✨ Key Features
1644

1745
- 🌐 **Domain-agnostic** - Track any experiment comparing parameters, data, and outcomes

docs/user-guide.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
Quick Start Guide
22
=================
33

4+
The Problem
5+
-----------
6+
7+
Modern data science and machine learning workflows involve countless experiments—tweaking hyperparameters, adjusting data preprocessing, testing different architectures, updating dependencies, modifying code. **Every change produces different results**, but tracking and comparing these variations manually becomes overwhelming:
8+
9+
- 📋 Which parameters, environment, or code version led to that breakthrough result last week?
10+
- 🔍 How does changing the learning rate affect convergence across multiple runs?
11+
- 📊 What's the actual performance difference between model architectures?
12+
- 🤔 Which preprocessing steps improved accuracy by 2%?
13+
- 🔧 Did upgrading that dependency break model performance?
14+
- 💻 What code changes caused the regression?
15+
16+
Without systematic tracking of **parameters, metrics, code changes, dependencies, and environment**, you're flying blind—relying on scattered notes, terminal output, and memory. **Artifacta solves this** by automatically capturing experiments, configurations, code versions, and artifacts in one place with intelligent visualization.
17+
18+
Ecosystem & Alternatives
19+
------------------------
20+
21+
Artifacta is part of a growing ecosystem of experiment tracking tools. Popular alternatives include:
22+
23+
- `MLflow <https://mlflow.org/>`_ - Open-source platform from Databricks for ML lifecycle management
24+
- `Weights & Biases <https://wandb.ai/>`_ - Cloud-first experiment tracking with team collaboration features
25+
- `Neptune.ai <https://neptune.ai/>`_ - Metadata store for MLOps with extensive integrations
26+
- `Comet ML <https://www.comet.com/>`_ - ML platform with experiment tracking and model production monitoring
27+
28+
**Why Artifacta?** We focus on **automatic visualization discovery**, **domain-agnostic tracking** (not just ML), and **simple self-hosting** with a pre-built UI. No heavy dependencies, no mandatory cloud services—just install and start tracking.
29+
430
Installation
531
------------
632

0 commit comments

Comments
 (0)