docs(learn): document causal persistence contract - #237
Draft
cursor[bot] wants to merge 1 commit into
Draft
cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Sara Loera <saraeloop@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🧠 Noēsis Pull Request
Overview
Documents the current learning-event and
learn.jsonlpersistence contracts, including typed causal-link failures and accurate public enum/API behavior.Type of Change
Motivation & Context
The learning runtime requires persisted proposal records to carry
caused_by, but the public docs showed a stale inline event payload, an inaccurate artifact example, and a nonexistentLearnStatus.PENDINGvalue. This left adapter authors without a reliable way to join learning records to the canonical event trace or handle orphan-write failures.Technical Details
docs/reference/events.mdxwith the runtime artifact-reference payload and legacy compatibility constraint.docs/explanation/artifacts.mdxwith thelearn/1.0record shape, causal join example, and empty-log behavior.docs/reference/python-api.mdxwith currentLearnStatusvalues,LearnProposalfields,persist_episode_learning(...), andMissingCausalLinkErrorhandling.noesis/runtime/learning.py,noesis/domain/learning/{errors,model}.py,noesis/learn.py, andnoesis/trace/events.py.Validation
Required
pytestanduvare unavailable in this runner)Situational
npx --yes mintlify@latest broken-links)git diff --checkpassObservability & Safety
Documentation-only. Clarifies that callers must pass an existing event ID and that an empty causal link fails before
learn.jsonlis created or appended.