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

Retrieval library will need docs #53

Open
rstarmer opened this issue Jun 30, 2023 · 1 comment
Open

Retrieval library will need docs #53

rstarmer opened this issue Jun 30, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation P0 Priority 0 - essential

Comments

@rstarmer
Copy link
Member

As a developer and library user, I would like documentation to provide a quickstart and basic functional use case, so that I can come up to speed on the use of this libary.

Acceptance: A user should be able to understand the basic workings of the library, expected inputs, and expected output capabilities.

@rstarmer rstarmer added the documentation Improvements or additions to documentation label Jun 30, 2023
@sdake sdake added the P0 Priority 0 - essential label Oct 11, 2023
@sdake
Copy link
Member

sdake commented Oct 11, 2023

Hi gang.

I think we have a good path forward, once we have a complete evaluation of a generation from RAG.

I deo believe, though, that we need to spend a little time coming up with our post-prototype capabilities.

Here is what I suggest:

  • A python library that works with our platform.
  • The python library exports 5-10 objects.
  • Linking our main components directly so that they share memory and can interact more affordably.

These three things should be enough. I want to spend two 45 minute sessions Thur, and Fri where our primary operation is defining the API objects and their verbs. I will also schedule for today (Wednesday) for 4:30 PM. We

Thank you,
-steve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P0 Priority 0 - essential
Projects
None yet
Development

No branches or pull requests

3 participants