Skip to content

Docs/public api guides - #133

Open
Ninjani wants to merge 14 commits into
mainfrom
docs/public-api-guides
Open

Ninjani wants to merge 14 commits into
mainfrom
docs/public-api-guides

Conversation

@Ninjani

@Ninjani Ninjani commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Update README and task-based guides for querying, structures, similarities, representatives, search, and evaluation.
  • Generate README counts from release tables and move release history to CHANGELOG.md.
  • Add interface-site discovery for monomer structures and FASTA inputs, and simplify search modes.
  • Add queryable score shards to reduce downloads for targeted similarity queries.
  • Expose per-ligand and ligand-pocket validation independently of system aggregates; consistently exclude hydrogen isotopes from heavy-atom counts and occupancy/B-factor averages.
  • Add chain-completeness metadata and derive missing values during entry updates while preserving strict validation.
  • Make documentation CI reproducible with a small local release fixture.

@github-actions

github-actions Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  src/plinder/core
  release.py
  src/plinder/core/index
  interface.py
  query.py 307
  system.py
  utils.py 115
  src/plinder/core/scores
  custom.py 2917-2927, 3065, 3303-3323
  interface.py
  ligand.py
  metrics.py
  protein.py
  query.py
  search.py 121
  store.py 81
  src/plinder/core/utils
  sanitize.py
  src/plinder/data/annotations
  aggregate_annotations.py
  get_ligand_validation.py 20
  get_similarity_scores.py
  interface_utils.py
  ligand_utils.py
  ligand_validation.py
  src/plinder/data/pipeline
  collate.py
  pipeline.py
  public_release.py 52
  score_store.py 96, 181, 183, 226, 232, 271, 318-327, 338
  update_entries.py
Project Total  

The report is truncated to 25 files out of 34. To see the full report, please visit the workflow summary page.

This report was generated by python-coverage-comment-action

@Ninjani
Ninjani requested a review from tjduigna October 13, 2026 18:48

@tjduigna tjduigna 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.

Thanks for the updates. Please address the existing-release update regression noted inline before merging. All required CI checks pass.

_fetch_scalar(
connection,
"SELECT count(*) FROM entry_chains WHERE "
"chain_unresolved_fraction IS DISTINCT FROM "

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.

[P2] Backfill chain completeness before validating updates to existing releases

Please backfill chain_unresolved_fraction for retained legacy rows before this check. The documented update_entries flow keeps old_rows.*: releases produced by the base revision lack this column, so removal-only updates fail here. With incoming rows, UNION ALL BY NAME fills the retained rows with null, which also fails this comparison. The weekly-update fixture now supplies the field, so passing CI does not cover this case. Derive the legacy value from the existing count/length columns, preserve validation of supplied values, and add a base-format removal-only regression test.

@Ninjani
Ninjani requested a review from tjduigna October 14, 2026 19:53
("chain_modified_residues", pa.list_(pa.string())),
("chain_length", pa.int64()),
("chain_num_unresolved_residues", pa.int64()),
("chain_unresolved_fraction", pa.float64()),

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.

[P2] Backfill chain completeness in targeted repairs

Please derive missing chain_unresolved_fraction values in repair_collation() before checking the installed chain schema. Releases produced by the base revision lack this column. Even with a regenerated replacement sidecar, a metadata-only repair now fails with ValueError: installed entry_chains does not have the current schema. I reproduced this by repairing chain modification annotations; the same repair succeeds on the base revision. The new backfill in update_entries._combine_tables() covers weekly updates, but targeted repairs bypass it. Apply the same derivation to the repair path, preserve validation of supplied values, and add a regression test with a base-format installed chain table.

tjduigna
tjduigna previously approved these changes Oct 28, 2026

@tjduigna tjduigna 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.

Thanks for the fixes. Approving the code; required test and documentation checks still need to pass before merging.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants