Skip to content

Docs: update API checkpoint_dir examples for guardrails#34

Open
theproteinbot wants to merge 1 commit intomaranasgroup:mainfrom
theproteinbot:codex/readme-followup
Open

Docs: update API checkpoint_dir examples for guardrails#34
theproteinbot wants to merge 1 commit intomaranasgroup:mainfrom
theproteinbot:codex/readme-followup

Conversation

@theproteinbot
Copy link
Contributor

Summary

This is a minimal README-only follow-up to reflect the merged API hardening behavior.

Changes

  • Added one bullet in the Web API hardening list:
    • local backend (and modal with fallback) enforces checkpoint_dir under CATPRED_API_CHECKPOINT_ROOT.
  • Updated the local /predict example to use:
    • "checkpoint_dir": "kcat"
      instead of a parent-relative path that now violates path guardrails.
  • Added one clarifying sentence after modal routing notes to explain how to pass local checkpoint paths.

No code changes.

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.

1 participant