docs: install the [agent] extra in README and correct a baseline comment - #403
Merged
Merged
Conversation
Two text-only corrections. No behavior changes. README's Get started block installs plain `agentops-accelerator`, then sends the reader straight to the Prompt Agent and Hosted Agent tutorials. Both tutorials use commands that live behind the `[agent]` extra, so a reader who follows the README verbatim hits an ImportError partway through. The published docs were corrected to install the extra; this brings the README in line and says which commands need it. The comment above `_PR_BASELINE_PATH` in services/cicd.py claims passing `--baseline` makes "threshold comparisons run against the committed baseline". It does not. `exit_code_from` in pipeline/orchestrator.py returns 0 or 2 purely from `result.summary.overall_passed`, which the configured thresholds decide. comparison.py produces `regressed`, `current_passed`, and `baseline_passed` for the report and nothing that reaches the exit code. A run that regresses against the baseline but still clears its thresholds exits 0. The comment now says so, since it is the thing a reader consults when deciding whether committing a baseline gives them a gate. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: bcb9c0b6-d506-46dc-90d2-8120413166ee
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.
Two text-only corrections found while auditing the published docs. No behavior changes, no new tests needed.
1. README sends readers down an incomplete install
README.mdopens with:and then links straight to the Prompt Agent and Hosted Agent tutorials. Both tutorials use commands that live behind the
[agent]extra (agentops cockpit,agentops agent serve, the observability commands), so a reader who follows the README verbatim gets anImportErrorpartway through the tutorial.[agent]carriesfastapi,uvicorn,azure-monitor-query, and theazure-mgmt-*SDKs.agentops init,agentops eval, andagentops doctorwork without it, becauseazure-identityandazure-ai-evaluationare base dependencies. The published tutorials were already corrected to install the extra; this brings the README in line and states which commands need it.2. A code comment claims
--baselinegates, and it does notThe comment above
_PR_BASELINE_PATHinsrc/agentops/services/cicd.pysays passing--baselinemakes "threshold comparisons run against the committed baseline".That is not what happens:
overall_passedis decided by the configured thresholds.pipeline/comparison.pyproducesregressed,current_passed,baseline_passed, andbaseline_overall_passedfor the report, and none of them reach the exit code. A run that regresses against the baseline but still clears its thresholds exits0and the PR gate stays green.This matters because the comment is what a reader consults when deciding whether committing a baseline buys them a regression gate. It does not. The comment now says so and points at the function that decides.
The same misstatement existed in the published tutorial and was corrected separately in #394.