Skip to content

Prepare SemanticMemo 2.0.1 release - #2

Merged
rajveer100704 merged 1 commit into
mainfrom
docs/pypi-readme-release-2.0.1
Oct 29, 2026
Merged

rajveer100704 merged 1 commit into
mainfrom
docs/pypi-readme-release-2.0.1

Conversation

@rajveer100704

@rajveer100704 rajveer100704 commented Oct 29, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Prepare SemanticMemo 2.0.1 by updating package metadata and the lockfile.
  • Update the PyPI README with retrieval-ranking and cache-safety evaluation results.
  • Add the 2.0.1 changelog entry and report the latest local test results.

Validation

  • uv lock --check passed.
  • uv run ruff format --check passed.
  • uv run ruff check passed.
  • uv run pyright passed with 0 errors.
  • uv run pytest -q: 253 passed, 14 skipped.
  • Built wheel and source distribution; both include the updated README.
  • twine check passed for both distributions.

The evaluation figures come from small, manually curated offline fixtures and are not production guarantees.

Release

This PR prepares version 2.0.1. Publishing to PyPI is a separate step after this PR is merged and release checks are confirmed.

Summary by Sourcery

Prepare the SemanticMemo 2.0.1 release with updated package metadata, evaluation documentation, safeguards, and validation records.

New Features:

  • Add offline retrieval relevance and cache-safety evaluation results, metrics, and limitations to the project documentation.
  • Add a 2.0.1 changelog entry covering retrieval benchmarks, ranking metrics, classifier guard refinements, and validation results.

Enhancements:

  • Refine opposite-action safeguards and expand regression coverage for conflicting and unrelated prompts.
  • Update CI and local validation reporting to reflect the latest test suite results.

Build:

  • Bump the package version to 2.0.1 and update the dependency lockfile.

Documentation:

  • Document retrieval-ranking comparisons, high-stakes cache-safety evaluations, and their offline-dataset limitations in the README.

Tests:

  • Record the latest full-suite validation results and retrieval regression coverage.

@sourcery-ai

sourcery-ai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

This release-preparation PR bumps SemanticMemo to 2.0.1, updates lock metadata, and documents the retrieval-quality and cache-safety evaluations, related regression coverage, limitations, and validation results without changing the implementation itself.

File-Level Changes

Change Details Files
Bump the project to version 2.0.1 and synchronize dependency lock metadata for the release.
  • Updated the package version from 2.0.0 to 2.0.1.
  • Regenerated the lockfile metadata.
pyproject.toml
uv.lock
Document retrieval-ranking and cache-safety evaluation results and their limitations for package users.
  • Added closed-corpus retrieval metrics comparing Sentence Transformer and TF-IDF ranking.
  • Added opposite-action evaluation metrics comparing cosine similarity with the equivalence classifier.
  • Clarified that the manually curated offline results are not production guarantees.
  • Updated the CI and local validation status.
README.md
Record the 2.0.1 feature, behavior, and validation changes in the project changelog.
  • Documented retrieval benchmarks, ranking metrics, baseline comparisons, reports, and regression coverage.
  • Documented refined opposite-action guards and precision regressions.
  • Recorded the latest test, lint, formatting, and CI results.
CHANGELOG.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai 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.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@rajveer100704
rajveer100704 merged commit 447f524 into main Oct 29, 2026
5 checks passed
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