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

Add Ask AI in README #9489

Closed
wants to merge 1 commit into from
Closed

Add Ask AI in README #9489

wants to merge 1 commit into from

Conversation

royaljain
Copy link

PR Description

Gen AI chatbot for vega-lite. Will help Developers understand this repository better. You can ask for code examples, installation guide, debugging help and much more.

Checklist

  • This PR is atomic (i.e., it fixes one issue at a time).
  • The title is a concise semantic commit message (e.g. "fix: correctly handle undefined properties").
  • yarn test runs successfully
  • For new features:
    • Has unit tests.
    • Has documentation under site/docs/ + examples.

Tips:

@royaljain royaljain requested a review from a team as a code owner December 2, 2024 14:30
@arvind
Copy link
Member

arvind commented Dec 2, 2024

Thank you for the PR. We're happy to hear suggestions (and receive PRs) on how to improve the repository, code examples, installation guide, debugging, etc. but will not be elevating a third party AI chatbot to the overall project README.

@arvind arvind closed this Dec 2, 2024
@domoritz
Copy link
Member

domoritz commented Dec 2, 2024

@royaljain contacted me about his work and asked whether we would be willing to show the tool in our repo. I said that I'm hesitant until we get a demo and can let people evaluate it. So this wasn't unsolicited. I should have given the team a heads up that I encouraged experimentation. Please excuse me for not doing that.

I agree that we shouldn't promote a particular bot to the readme anytime soon. Nonetheless, this could be interesting as it's specifically optimized for Vega-Lite. I'm encouraging experiments and will give this a try from time to time. But until some more advanced users had the chance to vet the quality, it's not ready to be in the readme where beginners may pick it up and get misled.

An important question is of course why a specific bot is needed when a generic one could work with any repo via something like llm.txt (https://github.com/AnswerDotAI/llms-txt). I don't know.

@domoritz
Copy link
Member

domoritz commented Dec 2, 2024

a bit of feedback. I played with it and asked a few basic questions that seemed to have reasonable answers. They were quite verbose and should be shorter, though. I'm also missing some explanation of what specific capabilities the model has and how it was adjusted for the Vega-Lite use case.

@royaljain
Copy link
Author

Hi @domoritz

-- how it was adjusted for the Vega-Lite use case

I created a RAG (Retrieval-Augmented Generation) using the docs, tutorials and usage folders in the repo. Have added prompts like "Vega-Lite provides a higher-level grammar for visual analysis that generates complete specifications. Users are Developers asking questions about the repo" to improve the response quality.

-- They were quite verbose and should be shorter, though

I can add these prompts to tune it further and add further resources like issues etc

-- An important question is of course why a specific bot is needed when a generic one could work with any repo via something like llm.txt (https://github.com/AnswerDotAI/llms-txt)

The main difference would be due to RAG. If unfamiliar, this is a database which contains concise representation about the repo and helps improve the context and thus the answers given by AI.

Overall, I am happy to work on improving the bot / wait for others to try and vet it further. But if it's a more fundamental issue, let me know if I should drop it.

Thanks.

@domoritz
Copy link
Member

domoritz commented Dec 3, 2024

Thanks for the explanation. I wonder whether a short intro in the bot that explains what it is and what it can do would be useful.

I'm not sure I get why llm.txt wouldn't be supporting rag in other tools.

The fundamental issue to me is that there are many many llm tools out now and they are hard to compare since you really need to probe them individually.

I can tell people on our slack about this tool and we will see what the reaction over time is.

How do you want to receive feedback?

@royaljain
Copy link
Author

-- I can tell people on our slack about this tool and we will see what the reaction over time is.

Makes sense. Email would be great.

@domoritz
Copy link
Member

domoritz commented Dec 3, 2024

Instead of adding this to the readme, I added it in a new section under AI tools: #9491

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

Successfully merging this pull request may close these issues.

3 participants