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

Configuration documentation update request #705

Open
ianawilson opened this issue May 1, 2024 · 1 comment
Open

Configuration documentation update request #705

ianawilson opened this issue May 1, 2024 · 1 comment

Comments

@ianawilson
Copy link

ianawilson commented May 1, 2024

Hi there, I was going through some of the config options and ended up having to read the code to understand them enough. A few options that I was looking at were path, keyword, and hybrid. While I worked out more about all of these, I'd love to see things like:

  • What's the default value?
  • What do various settings imply?
    • eg, keyword = True implies that a defaults should not be used for the model (code)
    • eg, path = None in combination with keyword = True or defaults = False will disable semantic search (same code as above)
    • What does hybrid with different combinations of keyword and path?

Also, I don't know if this is a txtai or pytorch flag, but I found PYTORCH_MPS_DISABLE referenced in the txtai code and this was really important for my team in dealing with an mps memory issue. Particularly if this is a txtai flag, it'd be great to have it documented.

@davidmezzetti
Copy link
Member

I'll work to clarify as best I can and update when that's complete.

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