# AGENTS.md

Visualizer for neural network, deep learning and machine learning models

## Setup

```
npm ci
```

## Commands

```
npm run start     # run the app
npm run build     # produce a build
npm run test      # run the test suite, must pass before any commit
npm run lint      # lint
npm run server
npm run clean
npm run install
npm run publish
```

## Layout

- `source/` 130 source files
- `tools/`  18 source files
- `test/`   9 source files

## Conventions

- Tests live alongside the code they cover, following `test/backend.py`.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `source/mlir.js` is 1132KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.