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

Better documentation #86

Open
nihal-amat opened this issue Dec 9, 2024 · 3 comments
Open

Better documentation #86

nihal-amat opened this issue Dec 9, 2024 · 3 comments

Comments

@nihal-amat
Copy link

The documentation for using the solution is really bad, there is no guide on how to use it/which files to execute and so on, could someone provide better documentation similar to this:

https://github.com/microsoft/graphrag

@BenConstable9
Copy link
Contributor

I'm looking to improve it as I know there are gaps. Let me know if you need anything clarified before it is all updated.

@nihal-amat
Copy link
Author

nihal-amat commented Dec 10, 2024

Some points:

  1. Just give one overall flow of what to run, how it is connected to other files, each step input and output (like data dictionary is used to create JSON files, then those are passed to the index used in AI search)
  2. Tried to explain the function of each file in a short format, and how each of them are related.

Also on a side note, in the deploy AI folder, in the structured rag approach, are all 3 (schema store, column value store and query cache index required) to run it?

@BenConstable9
Copy link
Contributor

Noted, thanks. Will improve these areas and make a get started guide.

Column value store / query cache are optional for the latest version but give better results.

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

No branches or pull requests

2 participants