Added LLM evaluator to example projects #1589
Conversation
|
WalkthroughThis pull request introduces documentation updates across multiple files, primarily focusing on adding GitHub repository links and expanding example project documentation. A new documentation file for a Batch LLM Evaluator project is added, which demonstrates using Vercel AI SDK and Trigger.dev's Realtime feature to evaluate multiple LLM models. The changes also include standardizing documentation by adding GitHub repository sections and updating the documentation navigation structure. Changes
Sequence DiagramsequenceDiagram
participant Frontend
participant BatchEvaluator
participant LLMModels
participant Trigger.dev
Frontend->>BatchEvaluator: Initiate Evaluation
BatchEvaluator->>Trigger.dev: batch.triggerByTaskAndWait
Trigger.dev->>LLMModels: Distribute Tasks
LLMModels-->>Trigger.dev: Return Results
Trigger.dev-->>BatchEvaluator: Aggregate Results
BatchEvaluator->>Frontend: Stream Real-time Updates
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🔇 Additional comments (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/guides/example-projects/batch-llm-evaluator.mdx (3)
11-13: Consider hyphenating compound adjectiveChange "full stack" to "full-stack" as it's being used as a compound adjective modifying "example".
-This demo is a full stack example that uses the following: +This demo is a full-stack example that uses the following:🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...more.mdx"; ## Overview This demo is a full stack example that uses the following: - A [...(EN_COMPOUND_ADJECTIVE_INTERNAL)
42-43: Fix verb-noun confusionChange "pass the relevant run down" to either "pass down the relevant run" or "pass the relevant run" for better clarity.
-We then pass the relevant run down into three different components for the different models: +We then pass down the relevant run into three different components for the different models:🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: When ‘run-down’ is used as a noun or modifier, it needs to be hyphenated.
Context: ....tsx) file. - We then pass the relevant run down into three different components for the...(VERB_NOUN_CONFUSION)
31-35: Enhance video accessibilityConsider adding more accessibility attributes to the video element, such as
posterfor a thumbnail andaria-labelfor screen readers.<video controls className="w-full aspect-video" + poster="https://content.trigger.dev/batch-llm-evaluator-poster.jpg" + aria-label="Demo of the Batch LLM Evaluator project" src="https://content.trigger.dev/batch-llm-evaluator.mp4" ></video>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
docs/guides/example-projects/batch-llm-evaluator.mdx(1 hunks)docs/guides/example-projects/realtime-fal-ai.mdx(2 hunks)docs/guides/examples/fal-ai-realtime.mdx(1 hunks)docs/guides/frameworks/nextjs-webhooks.mdx(1 hunks)docs/guides/frameworks/remix-webhooks.mdx(1 hunks)docs/guides/frameworks/supabase-edge-functions-basic.mdx(1 hunks)docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx(2 hunks)docs/mint.json(1 hunks)docs/snippets/realtime-learn-more.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/snippets/realtime-learn-more.mdx
- docs/guides/examples/fal-ai-realtime.mdx
🧰 Additional context used
🪛 LanguageTool
docs/guides/example-projects/batch-llm-evaluator.mdx
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...more.mdx"; ## Overview This demo is a full stack example that uses the following: - A [...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~43-~43: When ‘run-down’ is used as a noun or modifier, it needs to be hyphenated.
Context: ....tsx) file. - We then pass the relevant run down into three different components for the...
(VERB_NOUN_CONFUSION)
🔇 Additional comments (8)
docs/guides/example-projects/realtime-fal-ai.mdx (1)
7-8: LGTM! Documentation enhancementThe addition of the RealtimeLearnMore component improves the documentation by providing additional context about realtime features.
Also applies to: 45-46
docs/guides/frameworks/remix-webhooks.mdx (1)
12-21: LGTM! Documentation enhancementThe addition of the GitHub repository section with the Card component improves documentation accessibility by providing direct access to example code.
docs/guides/frameworks/nextjs-webhooks.mdx (1)
14-23: LGTM! Documentation enhancementThe addition of the GitHub repository section with the Card component improves documentation accessibility. The link correctly points to the specific app subdirectory in the examples repository.
docs/guides/frameworks/supabase-edge-functions-basic.mdx (1)
34-43: LGTM! Documentation enhancementThe addition of the GitHub repository section with the Card component improves documentation accessibility by providing direct access to example code.
docs/mint.json (1)
351-354: LGTM! Navigation structure updateThe addition of the batch LLM evaluator page to the Example projects group maintains consistent documentation structure.
docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx (1)
37-46: LGTM! Well-structured GitHub repository section.The added GitHub repository section follows documentation best practices with clear instructions and proper use of the Card component.
docs/guides/example-projects/batch-llm-evaluator.mdx (2)
39-47: LGTM! Clear and well-structured code explanation.The code explanation section effectively guides users through the key components and features of the project, with proper links to source files and explanations of the main concepts.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: When ‘run-down’ is used as a noun or modifier, it needs to be hyphenated.
Context: ....tsx) file. - We then pass the relevant run down into three different components for the...(VERB_NOUN_CONFUSION)
15-16: Consider adding version information for external dependenciesThe documentation references the Vercel AI SDK and
batch.triggerByTaskAndWaitmethod. Consider adding version information or compatibility notes to help users avoid version-related issues.
Summary by CodeRabbit
Documentation
New Features