Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 8 additions & 23 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,10 @@
# Copilot Coding Agent Instructions

You are working on **PyAutoFit**, a Python probabilistic programming library for model fitting and Bayesian inference.

## Key Rules

- Run tests after every change: `python -m pytest test_autofit/`
- Format code with `black autofit/`
- All files must use Unix line endings (LF, `\n`)
- If changing public API (function signatures, class names, import paths), clearly document what changed in your PR description — downstream packages depend on this

## Architecture

- `autofit/non_linear/search/` — Non-linear search algorithms (MCMC, nested sampling, MLE)
- `autofit/mapper/` — Model composition and prior machinery
- `autofit/graphical/` — Graphical models and expectation propagation
- `autofit/aggregator/` — Results aggregation
- `autofit/database/` — SQLAlchemy results database
- `test_autofit/` — Test suite

## Sandboxed runs

```bash
NUMBA_CACHE_DIR=/tmp/numba_cache MPLCONFIGDIR=/tmp/matplotlib python -m pytest test_autofit/
```
You are working on **PyAutoFit**, a probabilistic programming library for model
composition and non-linear search / Bayesian inference (package `autofit`).

The canonical, agent-agnostic instructions for this repo live in **`AGENTS.md`** at
the repository root — build and test commands, architecture, the model/search
subsystems, and conventions (including the `[nss]` / blackjax install gotcha). Read
it directly (Copilot does not process `@`-imports) and treat it as the single source
of truth.
20 changes: 20 additions & 0 deletions llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# PyAutoFit

> PyAutoFit (package `autofit`) is a probabilistic programming library for model composition and non-linear search / Bayesian inference — `af.Model`/`af.Collection`, the `af.Analysis` interface, MCMC / nested-sampling / MLE searches, and a results aggregator and database. This file is a signpost: it points you to the right resource by intent — use the API, learn it, or work on the library itself.

## Use it (examples & tutorials)

- [autofit_workspace navigator](https://github.com/PyAutoLabs/autofit_workspace/blob/main/llms.txt): end-to-end example scripts and notebooks per task — the paste-friendly task router. Send any "how do I compose a model / run a search / inspect results?" question here.
- [HowToFit](https://github.com/PyAutoLabs/HowToFit): from-first-principles lecture series on model fitting and Bayesian inference.

## API reference & docs

- [PyAutoFit documentation (ReadTheDocs)](https://pyautofit.readthedocs.io/en/latest/): API reference, feature overviews, and the installation guide.

## Work on it (contributors / coding agents)

- [AGENTS.md](./AGENTS.md): build, tests, architecture, and conventions.

## Ecosystem

- Built on PyAutoConf (config); used by PyAutoGalaxy and PyAutoLens, which build `Analysis` subclasses on it.
Loading