Skip to content

Get help

Report bugs and ask questions in the project's GitHub issues. Report security problems privately.

Report a problem

Open an issue at https://github.com/kundajelab/altar/issues for a bug, a question, or an error in these docs. Search the open and closed issues first.

A useful report includes:

  • the versions of Altar and of each binding involved (pip list | grep altar);
  • your operating system, and your CPU architecture and GPU if a model is involved;
  • the run spec or the code you ran, cut down to the smallest one that shows the problem;
  • what the run printed, from the first line. Rerun with -v for debug lines and the full traceback.

Leave out API keys, credentials and private variant data.

If a run stops with a message, Fix a run that stops or warns may already cover it.

Report a security issue

Do not open a public issue for a suspected vulnerability. Use the "Report a vulnerability" form in the repository's Security tab, which reaches the maintainers privately. Include the affected version, the impact, steps to reproduce it, and any fix you suggest. You should get an acknowledgement within seven days. The full policy is in SECURITY.md.

What is in scope

The project handles problems in:

  • the altar and altar-identity packages;
  • the bindings and the runtime images built from this repository;
  • these docs, the examples and the tutorials.

Take these to their own projects:

  • a model's science or its predictions, to the model's authors;
  • a dataset's content, such as a gnomAD frequency or a ClinVar classification, to its provider;
  • a hosted service, such as the AlphaGenome API, to its provider.

A vulnerability in an upstream model, runtime or hosted service should also go to that project's security contact.

Altar is not for clinical use, and the project cannot advise on the interpretation of a patient's variants.