Conversation
WalkthroughA new README file was introduced for a workshop titled "Timeseries QA with LLMs: Combine Telemetry Data and Manuals for Smarter Diagnostics." This documentation details a hands-on lab where participants build an AI assistant that utilizes timeseries telemetry data from CrateDB and structured machine manuals, leveraging OpenAI's language models. The README covers the workshop's objectives, required skills, and provides resources for running the associated notebook in Google Colab or viewing it on GitHub. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
topic/chatbot/dis2025/workshop/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
topic/chatbot/dis2025/workshop/README.md
1-1: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
2-2: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
topic/chatbot/dis2025/workshop/README.md (1)
1-2: Convert title to a proper Markdown heading
This section uses a generic placeholder heading with trailing punctuation and emphasis for the subtitle, violating MD026 (no trailing punctuation in headings) and MD036 (don’t use emphasis instead of headings). Consolidate into a single H1 without trailing punctuation and remove the emphasis.
Apply this diff:-# Workshop Title: -**"Timeseries QA with LLMs: Combine Telemetry Data and Manuals for Smarter Diagnostics"** +# Timeseries QA with LLMs: Combine Telemetry Data and Manuals for Smarter Diagnostics🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
2-2: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
topic/chatbot/dis2025/workshop/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
topic/chatbot/dis2025/workshop/README.md
1-1: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
2-2: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
|
@amotl Could you please verify and merge? |
amotl
left a comment
There was a problem hiding this comment.
Thanks. I've just added two nitpick comments.
Enjoy and good luck with the workshop.
| "# Install dependencies\n", | ||
| "!pip install pandas matplotlib openai sqlalchemy python-dotenv ipython-sql\n", |
There was a problem hiding this comment.
Excellent choice selecting ipython-sql. However, I can't spot any %%sql blocks, are you actually using it? On another occasion, you may want to try JupySQL?
-- See examples with CrateDB here: https://github.com/crate/cratedb-examples/tree/main/notebook/jupyter
There was a problem hiding this comment.
About the venerable and nitpicky topic of »naming things«, I would choose a more concise name for this file, not necessarily using a mixture of uppercase vs. lowercase letters, nor underscores. I also think dis2025/workshop/*Workshop bears some redundancy or unnecessary nesting.
As this piece is also apparently about the TAG topic, why not just slot it into the existing folder chatbot/table-augmented-generation, for example using a name like telemetry-timeseries-qa-assistant.ipynb or telemetry-diagnostics-assistant.ipynb, which touches a few key topics about what's inside?
If you are in a hurry to get this merged, please do, but please don't print the URL on paper, because it will change later on a subsequent iteration, in one way or another.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
topic/chatbot/table-augmented-generation/workshop/README.md (3)
1-2: Simplify and normalize the top‐level heading
The current pattern (“# Workshop Title:” + bold text) triggers markdownlint rules (MD026, MD036) and is more verbose than necessary. Combine into a single H1 without trailing punctuation.- # Workshop Title: - **"Timeseries QA with LLMs: Combine Telemetry Data and Manuals for Smarter Diagnostics"** + # Timeseries QA with LLMs: Combine Telemetry Data and Manuals for Smarter Diagnostics🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
2-2: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
6-16: Unify “timeseries” hyphenation
You use both “timeseries” (one word) and “time-series” elsewhere; pick one style for consistency (e.g., “time-series” as one or two words). Also consider ending list bullets without a period or consistently apply punctuation across all items.- In this hands-on workshop, participants will build an AI-powered assistant that can answer questions using a combination of **timeseries telemetry data** and **structured machine manuals**. + In this hands-on workshop, participants will build an AI-powered assistant that can answer questions using a combination of **time-series telemetry data** and **structured machine manuals**
57-68: Verify external links point to the correct branch
The Colab and GitHub URLs point tomain. Ensure that once merged, the notebook exists at those paths onmain; otherwise consider using a dynamic reference likeblob/${{ github.ref }}or update post-merge.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
topic/chatbot/table-augmented-generation/workshop/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
topic/chatbot/table-augmented-generation/workshop/README.md
1-1: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
2-2: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
🔇 Additional comments (5)
topic/chatbot/table-augmented-generation/workshop/README.md (5)
17-20: Approved: Summary paragraph structure
The paragraph cleanly describes TAG and prompt‐design focus. No changes needed.
23-31: Approved: Key Takeaways section
Bullet points are clear and consistent; good high‐level overview.
34-40: Approved: Requirements from Attendees
The prerequisites are well specified. Consider adding a note about network access if needed in your environment, but that’s optional.
43-47: Approved: Maturity Level designation
The maturity level is clear and appropriate for the target audience.
50-54: Approved: Workshop Type declaration
Hands‐On Lab classification is clear and concise.
Summary of the changes / Why this is an improvement
This is the notebook we want to use for DIS2025. In order for participants to be able to use this, it needs to be on a public repo.
Checklist