# AGENTS.md

Build and share delightful machine learning apps, all in Python. 🌟 Star to support our work!

## Setup

```
pnpm install
```

## Commands

```
pnpm dev            # run locally
pnpm build          # produce a build
pnpm test           # run the test suite, must pass before any commit
pnpm lint           # lint
pnpm css
pnpm format:check
pnpm format:write
pnpm ts:check
```

## Layout

- `js/`     1052 source files
- `demo/`   464 source files
- `gradio/` 180 source files
- `test/`   83 source files
- `client/` 59 source files
- `home/`   49 source files

## Conventions

- Tests live alongside the code they cover, following `client/js/src/test/api_info.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/comment-queue.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `client/python/test/media_data.py` is 706KB. 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.