Skip to content

docs: add new gp kernels to predictor rest api spec - #189

Merged
markgeejw merged 1 commit into
developfrom
docs/gp-kernel-expansion
Jul 2, 2026
Merged

docs: add new gp kernels to predictor rest api spec#189
markgeejw merged 1 commit into
developfrom
docs/gp-kernel-expansion

Conversation

@CBepler

@CBepler CBepler commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Update the predictor REST API docs to reflect the new GP kernels. The docs site
renders the predictor API via Swagger UI from the checked-in OpenAPI bundle
source/_static/js/predictorSpec.js; this regenerates the Kernel schema in
that bundle to match the openprotein-api source.

Changes

  • Kernel.type enum: rename matern21 -> matern12; add matern52,
    periodic, rational_quadratic.
  • Add the period (periodic) and alpha (rational_quadratic) kernel
    hyperparameters.

Surgical edit to the Kernel block only (matching the file's existing style),
rather than a full re-bundle, to keep the diff reviewable. Verified by serving
the site locally (sphinx-autobuild) and confirming the predictor page renders
the updated schema.

Merge order

Mirrors the OpenAPI source change in OpenProteinAI/openprotein-api#15
(feat: add matern52/periodic/rational_quadratic to the Kernel schema). Merge
after that PR, since this reflects spec content that lands there.

Regenerate the predictor OpenAPI bundle (source/_static/js/predictorSpec.js)
from openprotein-api: rename matern21 -> matern12, add matern52, periodic,
rational_quadratic, and the period/alpha kernel hyperparameters.
@CBepler
CBepler requested a review from markgeejw June 19, 2026 18:10
@markgeejw
markgeejw merged commit 58b8ec2 into develop Jul 2, 2026
2 checks passed
@markgeejw
markgeejw deleted the docs/gp-kernel-expansion branch July 2, 2026 14:08
markgeejw pushed a commit that referenced this pull request Jul 20, 2026
Regenerate the predictor OpenAPI bundle (source/_static/js/predictorSpec.js)
from openprotein-api: rename matern21 -> matern12, add matern52, periodic,
rational_quadratic, and the period/alpha kernel hyperparameters.

Co-authored-by: Christian Bepler <cbepler@ne47.bio>
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.

2 participants