Skip to content

doc update for #172: updating the docs to correctly reflect that msa … - #337

Open
Pana-TsK wants to merge 5 commits into
aqlaboratory:mainfrom
Pana-TsK:docs/fix-172-msa-chain-level
Open

doc update for #172: updating the docs to correctly reflect that msa …#337
Pana-TsK wants to merge 5 commits into
aqlaboratory:mainfrom
Pana-TsK:docs/fix-172-msa-chain-level

Conversation

@Pana-TsK

Copy link
Copy Markdown
Contributor

Fixes #172

use_msas, use_main_msas, and use_paired_msas are defined on Query
(openfold3/projects/of3_all_atom/config/inference_query_format.py), not on
Chain. Since Chain has extra: "forbid", setting any of these at the
chain level raises a pydantic validation error.

This moves the field docs and examples from the per-chain sections
(3.1 Protein chains, 3.2 RNA chains) to the query-level section (Section 2),
adds a note in Section 3 pointing readers to the query-level fields, and
updates the full example JSON in Section 4 accordingly. No code changes.

Note: this branch's CI may show the "Linting code" / ruff check as failing
on docs/source/debugging_how_to.md — that's pre-existing, caused by
astral-sh/ruff-action@v3 picking up ruff 0.16.0 (which made Markdown
Python-code-block formatting default-on), unrelated to this change.

…ct that msa related features are defined at the query level, and not at the per-chain level.
@jandom jandom added the documentation Improvements or additions to documentation label Jul 27, 2026
@jandom
jandom self-requested a review July 27, 2026 13:00

@jnwei jnwei left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you so much for the docs update @Pana-TsK ! We really appreciate it.

Just one small correction re MSA free predictions

Comment thread docs/source/input_format_reference.md Outdated
Pana-TsK added 4 commits July 28, 2026 11:50
Per @jnwei's review on aqlaboratory#337: the pipeline already falls back to a
single-sequence MSA automatically whenever use_msas is false
(data_module.py's prepare_data() calls
augment_main_msa_with_query_sequence() unconditionally when
use_msa_server=False), so the old wording implying users need to
construct a dummy MSA themselves was inaccurate.
@Pana-TsK

Copy link
Copy Markdown
Contributor Author

Should be alright now, let me know

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] MSA related features not allowed at the chain level.

3 participants