Docs: document /retrieve/recommend and RecSys benchmarks - #85
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
Align root and benchmarks READMEs with /retrieve/recommend, synergy knobs, and the new RecSys suite after the 2.15.0-dev landing. Co-authored-by: Christian <ChrisCoder9000@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
1 participant
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.
Summary
After main
1e4cf88(recommend/synergy APIs + RecSys harness), in-repo READMEs were still describing synergies as the only recommendation path and omitted RecSys from the benchmarks index.Changes
README.md: add/retrieve/recommend, clarify synergies vs recommend, fix docs link to/docs/v2benchmarks/README.md: add BEAM + RecSys to the suite table and a RecSys quickstart sectionHosted docs (cannot fix from this repo)
Public docs at https://brainapi.lumen-labs.ai/docs/v2 still need:
/docs/v2/retrieval/recommendpage for GET/POST/retrieve/recommendpolarity,top_k,labels(polarity is now implemented)/docs/v2/benchmarks/recsyspage for./recsys.sh/retrieve/recommend, not only Synergies