We appreciate your contributions to help us improve and maintain this community resource!
Sign in to like and favorite skills
We appreciate your contributions to help us improve and maintain this community resource!
For quick fixes like correcting a typo or patching an obvious bug, feel free to open a pull request directly.
If you're considering a larger or more involved change to this repository, its organization, or the functionality of one of the examples, please first open a new issue and describe your proposed changes so we can discuss them together before you invest a ton of time or effort into making changes.
This repository uses uv for fast Python package management.
Install dependencies:
uv sync
Install pre-commit hooks:
uv run pre-commit install
The hooks will automatically format and lint your code when you commit.
# Lint a file uv run ruff check path/to/file.py # Format a file uv run ruff format path/to/file.py
.ai/notebook-standards.md.ai/quality-checklist.md.ai/writing-guidelines.mdThis repository includes specialized AI agents and skills to help with common tasks. Both Claude Code and Cursor users can leverage these tools.
Use these slash command skills for common tasks:
/validate-notebook path/to/notebook.ipynb # Check notebook quality /review-notebook-writing path/to/notebook.ipynb # Review writing style /update-notebook-shields path/to/notebook.ipynb # Add/update badges
We have 5 specialized agents for complex workflows. Simply describe what you need in natural language, and the appropriate agent will help.
Agents are in
.claude/agents/# Review a notebook "Review the semantic-search.ipynb notebook for quality issues" # Create a new notebook "Create a notebook showing RAG with Cohere embeddings" # Test examples "Test all notebooks in learn/search/ for errors" # Update documentation "Fix all broken links in the README files" # Migrate to new SDK "Migrate integrations/openai/ examples to SDK v8"
Commands are in
.cursor/commands/# Review a notebook "Use notebook-reviewer to check semantic-search.ipynb" # Create a new notebook "Use notebook-creator to build a hybrid search example" # Test examples "Use pinecone-tester on the RAG notebook" # Update documentation "Use docs-updater to validate all links" # Migrate to new SDK "Use example-migrator to update deprecated patterns"
| Agent | Purpose | Location |
|---|---|---|
| notebook-reviewer | Review notebooks against quality standards | |
| notebook-creator | Create new notebooks following best practices | |
| pinecone-tester | Test Pinecone integrations and validate SDK usage | |
| docs-updater | Update documentation and maintain consistency | |
| example-migrator | Migrate examples to newer SDK versions | |
Each agent has full access to repository standards in
.ai/See
AGENTS.md