8000 add LLM chatbot to Dask docs by dchudz · Pull Request #11556 · dask/dask · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

add LLM chatbot to Dask docs #11556

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

Merged
merged 5 commits into from
Nov 27, 2024

Conversation

dchudz
Copy link
Contributor
@dchudz dchudz commented Nov 21, 2024

This adds a LLM chatbot (using RAG based on Dask docs, StackOverflow Q&A, and a few other Dask-related sources) to the Dask docs. It's something I talked with a few Dask contributors about (@mrocklin , @jrbourbeau , @fjetter, @jacobtomlinson via Florian) before getting this pull request ready.

We (I and some other folks at Coiled) have played a bit with the questions and answers and think the quality is high enough to try out on real users, but we (@jrbourbeau for now) will plan to monitor the Q&A for quality.

It's implemented using a product (https://runllm.com/) that Coiled plans to pay for (and continue paying for if this experiment goes well and we keep this in the docs). To avoid paying unlimited amounts for anonymous questions and limit abuse, we're requiring users to join the Dask Slack to send more than 2 queries.

Some considerations going into the choices here:

  • Discourse would have been better since the Dask community is much more present there; supporting Discourse is more complicated than Slack, but it's on RunLLM's roadmap. We'd probably want to switch to pushing people there once it's an option. (I've created the Slack channel "DaskBot" for this and set up the integration.)
  • I picked the middle/right side of the screen for the button, since dask.docs.org already shows ads in the bottom right.
  • We can't currently change the text "Ask AI", but if people feel it's important to switch to something more like "Ask Daskbot", I can let the RunLLM people know we'd really like to make that switch in the future.
Screenshot 2024-11-21 at 5 12 20 PM Screenshot 2024-11-21 at 5 12 06 PM

Copy link
Contributor
github-actions bot commented Nov 21, 2024

Unit Test Results

See test report for an extended history of previous test failures. This is useful for diagnosing flaky tests.

     15 files  ±0       15 suites  ±0   4h 7m 32s ⏱️ - 4m 13s
 13 256 tests ±0   12 194 ✅ ±0   1 062 💤 ±0  0 ❌ ±0 
164 446 runs  ±0  141 529 ✅ ±0  22 917 💤 ±0  0 ❌ ±0 

Results for commit bb7609f. ± Comparison against base commit aafde77.

♻️ This comment has been updated with latest results.

Copy link
Member
@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is exciting, thanks @dchudz!

Should we put this directly in the Dask theme instead of just in dask/dask? That way it will be present in distributed and all the other Dask subprojects.

I'm also not sure about the wording "Ask AI" on the button. I feel like we are at the point where lots of people have AI fatigue and people may be put off by that wording.

I totally agree about Discourse. We talked for a while about shutting the Slack down because it's generally not a good place to provide support. So it feels a little weird adding a feature that increases our Slack traffic. I understand the flow is to chat to the bot in the browser for a bit, and then have it move the conversation to a Slack channel. But perhaps we could remove the "Join our community" button given that our community isn't actually on Slack?

Also I noticed that the bot doesn't work in the RTD build preview. Perhaps it's a domain issue?

image

@dchudz
Copy link
Contributor Author
dchudz commented Nov 22, 2024

Thanks Jacob! Yeah, the docs preview thing is a problem with the domain. I'll get them to allowlist it. In the meantime if you feel like it (not that I expect this effort to be worthwhile for you), localhost is currently allow-listed so you're welcome play with it locally if you like.

I'll push them on "Join our community" as well as "Ask AI". Hopefully that's easy for them to make configurable for us.

Should we put this directly in the Dask theme

Good idea! Although I think we wouldn't get docs previews, so maybe I should leave it here for now? Or my screenshots are sufficient preview, happy to make that switch now.

@mrocklin
Copy link
Member

I'll push them on "Join our community" as well as "Ask AI".

I'd go for "Ask Dask" or "Ask DaskBot" or something.

@jacobtomlinson
Copy link
Member

Or my screenshots are sufficient preview, happy to make that switch now.

Totally happy with screenshots for preview. If you could switch it that would be awesome.

I'd go for "Ask Dask" or "Ask DaskBot" or something.

Yeah I like something more along these lines.

@dchudz
Copy link
Contributor Author
dchudz commented Nov 26, 2024

Just pushed chages for:

  1. "Ask DaskBot"
  2. Not mention "Slack Community" (I have "Chat with DaskBot in Slack").
Screenshot 2024-11-25 at 10 37 31 PM

@jacobtomlinson I had a little trouble figuring out stuff with the sphinx theme, and then I realized RunLLM needs to allow-list the all domains we'll use, so it wouldn't just automatically work on any new Dask project anyway.

Probably still good to get it in the theme and allow-list existing projects but how about we just start here and expand to other projects later?

@jacobtomlinson
Copy link
Member

Can they allowlist a wildcard? E.g *.dask.org That would cover everything we need.

If we merge this here it'll need to be removed again when it's added to the theme. Are you happy to own that action?

Copy link
Member
@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you happy to own that action?

I'm happy to make sure that gets done

Copy link
Member
@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jrbourbeau @dchudz. Let's do it then! Thanks for funding this effort Coiled folks!

@jacobtomlinson jacobtomlinson merged commit 0f3e5ff into dask:main Nov 27, 2024
26 checks passed
Copy link
Member
@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dchudz for the work here and @jacobtomlinson for reviewing

dchudz added a commit to dchudz/dask that referenced this pull request Dec 3, 2024
9372
dchudz added a commit to dchudz/dask that referenced this pull request Dec 10, 2024
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.

4 participants
0