Skip to content

docs: sync README files with latest repo state#381

Open
yyiilluu wants to merge 1 commit into
mainfrom
docs/sync-readmes-20260725
Open

docs: sync README files with latest repo state#381
yyiilluu wants to merge 1 commit into
mainfrom
docs/sync-readmes-20260725

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updated model-facing code-map READMEs for the new agent_success_evaluation/sampling.py module.
  • Documented the per-family sampling contract for session-success and retrieved-learning evaluation.

Repositories/submodules reviewed

  • Parent: ReflexioAI/reflexio-enterprise
  • Submodules: ReflexioAI/claude-smart, ReflexioAI/reflexio

README files updated

  • reflexio/server/README.md
  • reflexio/server/services/README.md
  • reflexio/server/services/agent_success_evaluation/README.md

Validation

  • git diff --check
  • python /root/.hermes/skills/github/scheduled-code-map-readme-maintenance/scripts/readme_link_check.py . reflexio/server/README.md reflexio/server/services/README.md reflexio/server/services/agent_success_evaluation/README.md

Notes/Risks

  • Updates follow the parent repository policy in how_to_write_readme.md for model-facing code-map READMEs.
  • README-only change; no code changes and no parent submodule pointer commit.

Summary by CodeRabbit

  • Documentation
    • Documented deterministic, per-session sampling for agent success and retrieved-learning evaluations.
    • Added guidance for configuring sampling rates, including evaluation-only overrides and separate retrieved-learning sampling density.
    • Clarified that scheduled publishing applies sampling decisions, while direct evaluation runs execute both judge families by default.

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Changes

Agent Success Sampling Documentation

Layer / File(s) Summary
Sampling contract documentation
reflexio/server/services/agent_success_evaluation/README.md
Documents deterministic per-session sampling gates, configuration rates, inheritance behavior, and direct runner behavior.
Server documentation alignment
reflexio/server/README.md, reflexio/server/services/README.md
Updates the server overview and services index to reference the sampling module and its session-level semantics.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: guangyu-reflexio

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is related, but it is too generic and does not reflect the specific sampling-contract README updates. Use a more specific title mentioning the new agent_success_evaluation sampling documentation and README updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-readmes-20260725

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@reflexio/server/README.md`:
- Line 427: Update the README flow description around the sampling entry to
distinguish inactivity scheduling from publish admission: show that
generation_service.py and sampling.py own publish-path sampling, while
agent_success_evaluation/scheduler.py handles the separate inactivity path.
Ensure the documented flow no longer implies that publish admission routes
directly through the inactivity scheduler.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1663b6a8-ac8b-406a-a5e6-c16a1bbc2452

📥 Commits

Reviewing files that changed from the base of the PR and between d777db3 and 98dd21d.

📒 Files selected for processing (3)
  • reflexio/server/README.md
  • reflexio/server/services/README.md
  • reflexio/server/services/agent_success_evaluation/README.md

Comment thread reflexio/server/README.md
- `agent_success_evaluation_constants.py`: Output schema (`AgentSuccessEvaluationOutput`)
- `agent_success_evaluation_utils.py`: Message construction utilities
- `scheduler.py`: `GroupEvaluationScheduler` singleton - min-heap priority queue with daemon thread, defers evaluation until 10 min after last request in session
- `sampling.py`: deterministic per-session sampling for the session-success and retrieved-learning judge families; the publish scheduler samples once and passes explicit booleans to the runner

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Align the flow description with the documented sampling owner.

This new entry correctly says generation_service.py performs publish-path sampling, but the adjacent flow still routes directly through agent_success_evaluation/scheduler.py. Clarify that the inactivity scheduler and publish admission are separate paths, or update the flow to include generation_service.py/sampling.py.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@reflexio/server/README.md` at line 427, Update the README flow description
around the sampling entry to distinguish inactivity scheduling from publish
admission: show that generation_service.py and sampling.py own publish-path
sampling, while agent_success_evaluation/scheduler.py handles the separate
inactivity path. Ensure the documented flow no longer implies that publish
admission routes directly through the inactivity scheduler.

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