# AGENTS.md

DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make help
make test     # run the test suite, must pass before any commit
make format   # format
```

## Layout

- `deepspeed/`   709 source files
- `tests/`       327 source files
- `csrc/`        165 source files
- `op_builder/`  91 source files
- `accelerator/` 12 source files
- `examples/`    7 source files

## Conventions

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

## Gotchas

- `deepspeed/runtime/engine.py` is 287KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.