# AGENTS.md

Qlib is an AI-oriented Quant investment platform that aims to use AI tech to empower Quant Research, from exploring ideas to implementing productions. Qlib supports diverse ML modeling paradigms, including supervised learning, market dynamics modeling, and RL, and is now equipped with https://github.com/microsoft/RD-Agent to automate R&D process.

## Setup

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

## Commands

```
make clean
make deepclean
make prerequisite
make dependencies
make lightgbm
make rl
```

## Layout

- `qlib/`     232 source files
- `examples/` 44 source files
- `tests/`    36 source files
- `scripts/`  20 source files
- `docs/`     2 source files

## Conventions

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

## Gotchas

- 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.