Files
finetuning-plattform-setup-…/README.md
m17hr1l 33635796ee docs: add USER_WORKFLOW.md — end-user journey from idea to trained model
Practical walk-through for someone landing on the platform without
context: pick a base model, prepare data, run a fine-tune, test the
result. Grounded in what the platform actually does today.

Covers the four main pages (/models, /datasets/upload, /jobs/create,
/jobs/view) and flags current limitations (NFP-52 chat-test gap for
platform-trained models, etc.). Includes an iteration table mapping
common failure modes to fixes, and a "first-week mistakes" list.

Linked from README alongside the developer MANUAL.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-20 22:57:08 +02:00

60 lines
2.2 KiB
Markdown

# Neuronetz Finetuning Platform — Setup Delta
Drop-in setup for new developers joining the platform.
**Start with [`MANUAL.md`](MANUAL.md)** — full developer manual with quick-start at the top.
→ End-user perspective: **[`USER_WORKFLOW.md`](USER_WORKFLOW.md)** — idea → data → train → test, in plain language.
## Quick orientation
```
MANUAL.md ← full software manual, setup at front
bootstrap-db.sh ← one-command DB initialization
db/01-schema.sql ← MariaDB schema (no data)
db/02-seed.sql ← reference data: ACL, email templates, API registry
db/03-default-users.sql ← admin@finetune.ai / admin123 and testuser@example.com / test123
db/dev-snapshot.sql ← Stephan's working state with test data — 5 datasets, 1 job,
1 model, etc. Secrets pre-scrubbed. Use this if you want
a populated platform instead of an empty one.
```
## Two bootstrap modes
**Clean install** (default) — empty platform, just users + reference data:
```bash
./bootstrap-db.sh
```
**Dev snapshot** — Stephan's local state with test data preloaded:
```bash
NFP_USE_SNAPSHOT=1 ./bootstrap-db.sh
```
Both arrive at the same credentials (`admin@finetune.ai/admin123`, `testuser@example.com/test123`). The snapshot just gives you something to look at on day 1.
## TL;DR (10 min for experienced devs)
```bash
# /etc/hosts (one line)
sudo sh -c 'echo "127.0.0.1 local.finetune.neuronetz.ai local.websocket.finetune.neuronetz.ai local.redis-commander.neuronetz.ai local.graylog.finetune.neuronetz.ai local.kibana.finetune.neuronetz.ai" >> /etc/hosts'
# clone both repos as siblings
mkdir -p ~/PhpstormProjects && cd ~/PhpstormProjects
git clone ssh://git@gitea.neuronetz.ai:222/Neuronetz/finetuning-plattform.git
git clone ssh://git@gitea.neuronetz.ai:222/m17hr1l/finetuning-plattform-setup-delta.git
# start the stack
cd finetuning-plattform && git checkout develop
cd local && docker compose up -d
cd ../..
# bootstrap the DB
cd finetuning-plattform-setup-delta
./bootstrap-db.sh
# done — open http://local.finetune.neuronetz.ai/auth/login
# admin@finetune.ai / admin123
```
Anything else: see `MANUAL.md` §4 (Troubleshooting Setup) and §21 (Common Gotchas).