Skip to content

Docs, bugs, and issues

You can contribute without touching model or task code: improve documentation, file clear bug reports, or propose features.

Improving documentation

Build the site locally

Prerequisite: complete Install from source in the Contributing hub (includes docs dependencies).

From the repository root:

mkdocs build

Preview with live reload:

mkdocs serve

Add or update a page

  1. Edit or create Markdown under docs/.
  2. Add an entry to the nav: section in mkdocs.yml so the page appears in the sidebar.
  3. Run mkdocs build to confirm the site builds.

The docs use MkDocs macros defined in main.py at the repo root:

  • [file.py](https://github.com/dhruvdcoder/xlm-core/blob/main/path/to/file.py) — link to a file on GitHub
  • [dir/](https://github.com/dhruvdcoder/xlm-core/tree/main/path/to/dir) — link to a directory on GitHub

Example in a doc source file:

See [harness.py](https://github.com/dhruvdcoder/xlm-core/blob/main/src/xlm/harness.py) for the Lightning module.

Reporting bugs

Before opening a bug report:

  1. Search Issues for duplicates.
  2. If you are unsure whether it is a library bug or your environment, ask in Q&A Discussions.

When filing a bug, use the bug report template and include:

  • A minimal repro script or exact xlm command
  • Versions (xlm-core, PyTorch, Lightning, Hydra) — e.g. python -c "import xlm; print(xlm.__version__)"
  • Relevant Hydra config (experiment=... and any overrides)
  • Expected vs actual behavior

Feature requests

Use the feature request template. Describe the problem, your proposed solution, and which component is affected (core, model, task, docs, CLI).

For new model families or datasets, prefer the dedicated templates:

Questions

Use Discussions or the question issue template and note what you have already tried.