Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: updated readme file to use semantic router #505

Merged
merged 2 commits into from
Feb 26, 2025

Conversation

Joshua-Briggs
Copy link
Member

@Joshua-Briggs Joshua-Briggs commented Jan 8, 2025

PR Type

Documentation


Description

  • Updated README to reflect usage of SemanticRouter.

  • Replaced references to RouteLayer with SemanticRouter.

  • Added auto_sync parameter in example code for clarity.


Changes walkthrough 📝

Relevant files
Documentation
README.md
Update README example to use `SemanticRouter`                       

README.md

  • Replaced RouteLayer with SemanticRouter in example code.
  • Updated import path to semantic_router.routers.
  • Added auto_sync="local" parameter to the SemanticRouter instantiation.
  • +2/-2     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @Joshua-Briggs Joshua-Briggs self-assigned this Jan 8, 2025
    @Joshua-Briggs Joshua-Briggs linked an issue Jan 8, 2025 that may be closed by this pull request
    Copy link

    github-actions bot commented Jan 8, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link

    github-actions bot commented Jan 8, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Verify the validity of the auto_sync parameter to prevent potential runtime issues

    Ensure that the auto_sync="local" parameter in the SemanticRouter initialization is
    valid and supported by the SemanticRouter class to avoid runtime errors.

    README.md [84]

    -rl = SemanticRouter(encoder=encoder, routes=routes, auto_sync="local")
    +rl = SemanticRouter(encoder=encoder, routes=routes, auto_sync="local")  # Ensure 'auto_sync' is a valid parameter
    Suggestion importance[1-10]: 7

    Why: The suggestion prompts the user to ensure that the auto_sync="local" parameter is valid, which is important to prevent runtime errors. However, it is not actionable beyond verification, which slightly reduces its impact.

    7

    Copy link

    codecov bot commented Jan 8, 2025

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 74.34%. Comparing base (8d184ad) to head (4b55384).
    Report is 14 commits behind head on main.

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main     #505   +/-   ##
    =======================================
      Coverage   74.34%   74.34%           
    =======================================
      Files          44       44           
      Lines        4221     4221           
    =======================================
      Hits         3138     3138           
      Misses       1083     1083           

    ☔ View full report in Codecov by Sentry.
    📢 Have feedback on the report? Share it here.

    @Joshua-Briggs Joshua-Briggs changed the title feat: updated readme file to use semantic router rather then old router layer feat: updated readme file to use semantic router Feb 26, 2025
    @jamescalam jamescalam merged commit 05fccb5 into main Feb 26, 2025
    9 of 10 checks passed
    @jamescalam jamescalam deleted the josh/update-readme-doc branch February 26, 2025 09:22
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    Update all Jupyter notebooks for v0.1.0
    2 participants