Skip to content

Conversation

@jsstevenson
Copy link
Member

@jsstevenson jsstevenson commented Jan 23, 2026

close #25

  • Move stuff from @larrybabb 's big PR from the README out into the docs.
  • Add basic features/usage overview
  • Add other docs boilerplate
  • I was intentionally light in some places w/ the expectation that we might change things a bit -- this was just supposed to be enough to get us through an initial release. For example, I'm not sure it's really meaningful to provide much of an API reference when AnyVLM might be used primarily via REST.
  • I have linked to the stable/ AnyVar docs. These don't exist yet because we haven't made a stable release. I think we probably should, but I'd rather just do dead links that become active instead of incorrect links that I forget to update

Viewable here: https://anyvlm--70.org.readthedocs.build/en/70/

@korikuzma to add github changelog API token as env var where needed if it's not already there (✅ )

@jsstevenson jsstevenson added the priority:medium Medium priority label Jan 23, 2026
@korikuzma
Copy link
Member

@korikuzma to add github changelog API token as env var where needed if it's not already there

Done

@jsstevenson jsstevenson marked this pull request as ready for review January 23, 2026 17:06
@jsstevenson jsstevenson requested a review from a team as a code owner January 23, 2026 17:06
Copy link
Member

@korikuzma korikuzma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small things


At present, AnyVLM serves `Cohort Allele Frequency (CAF) <https://va-spec.ga4gh.org/en/1.0/va-standard-profiles/base-profiles/study-result-profiles.html#cohort-allele-frequency-study-result>`_ objects, describing the frequency of an allele in a cohort. CAF objects may also report additional data, including frequency broken down by zygosity and quality control filters declared by the original variant calls.

.. figure:: /_static/img/caf.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a "citation"

This version of AnyVLM validates data using the following data standards:


.. list-table::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this

@jsstevenson jsstevenson requested a review from korikuzma January 24, 2026 19:21
@jsstevenson
Copy link
Member Author

Tweaked a few things + added some more config descriptions. I am not totally confident about my description of the VLM service info values

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add ReadTheDocs

3 participants