diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml deleted file mode 100644 index a989f5c..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml +++ /dev/null @@ -1,80 +0,0 @@ -name: Pull Request -description: Submit a pull request -title: "[Type of Change]: [Brief Description]" -body: - - type: dropdown - id: change-type - attributes: - label: Type of Change - options: - - New notebook - - Notebook update - - Documentation update - - Environment/dependency update - - Other - validations: - required: true - - type: textarea - id: description - attributes: - label: Description - description: What changes does this PR make? - validations: - required: true - - type: textarea - id: testing - attributes: - label: Testing - description: | - How have you verified these changes work? - For notebooks: - - Include a screen recording showing execution and outputs - - Or include screenshots of key outputs with explanation - - For documentation: - - Preview any markdown changes - - Test any new links or references - validations: - required: true - - type: checkboxes - id: notebook-checklist - attributes: - label: Notebook Changes Checklist - description: Complete this section if you're modifying notebooks - options: - - label: I have run the notebook from start to finish without errors - - label: I have cleared all cell outputs before committing - - label: I have included all required pip installations with pinned versions (e.g., pip install package==1.2.3) in %%sh cells at the start of the notebook - - label: I have included a screen recording or screenshots demonstrating the changes - - label: I have added sufficient markdown cells to explain the notebook's purpose and usage - validations: - required: false - - type: checkboxes - id: documentation-checklist - attributes: - label: Documentation Changes Checklist - description: Complete this section if you're modifying documentation - options: - - label: I have checked for similar wording/style issues across all documentation - - label: I have verified all links and references still work - - label: I have previewed how the changes will appear - - label: I have followed the repository's documentation style guide (if applicable) - validations: - required: false - - type: input - id: related-issues - attributes: - label: Related Issues - description: "Add any related issue numbers (e.g., Fixes #123)" - validations: - required: false - - type: markdown - attributes: - value: | - > **Note for notebook submissions:** - > - Run the notebook in a fresh environment (e.g., new conda env or colab instance) to ensure all dependencies are captured - > - Comments should explain the purpose of non-obvious code blocks and any external data dependencies - - > **Note for documentation updates:** - > - For minor changes, consider bundling multiple related improvements in one PR - > - Look for opportunities to improve similar sections across the documentation diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7f22dc4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,51 @@ +# Pull Request + +## Type of Change +Please select one: +- [ ] New notebook +- [ ] Notebook update +- [ ] Documentation update +- [ ] Environment/dependency update +- [ ] Other + +## Description +[What changes does this PR make?] + +## Testing +[Describe how you've verified these changes work] + +### For Notebooks: +- Include a screen recording showing execution and outputs +- Or include screenshots of key outputs with explanation + +### For Documentation: +- Preview any markdown changes +- Test any new links or references + +## Notebook Changes Checklist +Complete if modifying notebooks: +- [ ] I have run the notebook from start to finish without errors +- [ ] I have cleared all cell outputs before committing +- [ ] I have included all required pip installations with pinned versions (e.g., pip install package==1.2.3) in %%sh cells at the start of the notebook +- [ ] I have included a screen recording or screenshots demonstrating the changes +- [ ] I have added sufficient markdown cells to explain the notebook's purpose and usage + +## Documentation Changes Checklist +Complete if modifying documentation: +- [ ] I have checked for similar wording/style issues across all documentation +- [ ] I have verified all links and references still work +- [ ] I have previewed how the changes will appear +- [ ] I have followed the repository's documentation style guide (if applicable) + +## Related Issues +[Add any related issue numbers (e.g., Fixes #123)] + +--- + +> **Note for notebook submissions:** +> - Run the notebook in a fresh environment (e.g., new conda env or colab instance) to ensure all dependencies are captured +> - Comments should explain the purpose of non-obvious code blocks and any external data dependencies + +> **Note for documentation updates:** +> - For minor changes, consider bundling multiple related improvements in one PR +> - Look for opportunities to improve similar sections across the documentation diff --git a/README.md b/README.md index d5d2956..b4c1eac 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - # Cohere Examples +# Cohere Examples Welcome! This repository provides a collection of examples to help you build LLM-powered applications with the [Cohere API](https://docs.cohere.com/). They contain step-by-step guides, with code examples and explanations, to help you understand and use the API effectively. @@ -11,7 +11,30 @@ Interested to contribute? Read the [contributing guide](#contributing).
-# Getting Started +## Quick Start + +### Installation +```bash +# Install the Cohere Python SDK +pip install cohere + +# Clone this repository +git clone https://github.com/cohere-ai/notebooks.git +cd notebooks +``` + +### Authentication +```python +import cohere +co = cohere.Client('your-api-key') # Get your API key from dashboard.cohere.ai +``` + +## Prerequisites +- Python 3.7 or higher +- A Cohere API key ([Sign up here](https://dashboard.cohere.ai)) +- Familiarity with Jupyter notebooks + +## Getting Started This is a Cohere 101 guide. Build your first Cohere application: An onboarding assistant for new hires. Duration: ~15 mins. @@ -27,7 +50,7 @@ Duration: ~15 mins.
-# LLM University +## LLM University This section contains the code companion to the [LLM University](https://cohere.com/llmu) course containing a comprehensive list of modules. | Module | Title | Colab | @@ -68,7 +91,7 @@ This section contains the code companion to the [LLM University](https://cohere.
-# Cookbook +## Cookbook This section provides a deep dive into various techniques in the following topics: - [RAG](#rag) - [Agents](#agents) @@ -79,7 +102,7 @@ This section provides a deep dive into various techniques in the following topic
-## RAG +### RAG | Title | Components | Colab | |--------------------------------------------------------------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | [Basic RAG](https://github.com/cohere-ai/notebooks/blob/main/notebooks/Vanilla_RAG.ipynb) | Chat, Embed, Rerank | [Open In Colab](https://colab.research.google.com/github/cohere-ai/notebooks/blob/main/notebooks/Vanilla_RAG.ipynb) | @@ -92,7 +115,7 @@ This section provides a deep dive into various techniques in the following topic | [Adaptive RAG](https://github.com/cohere-ai/notebooks/blob/main/notebooks/agents/Multi_Step_Tool_Use.ipynb) | Chat, LangChain | [Open In Colab](https://colab.research.google.com/github/cohere-ai/notebooks/blob/main/notebooks/agents/Multi_Step_Tool_Use.ipynb) | -## Agents +### Agents | Title | Components | Colab | |--------------------------------------------------------------|--------------------------------|-----------------| @@ -120,7 +143,7 @@ This section provides a deep dive into various techniques in the following topic | [Wikipedia Semantic Search with Cohere + Weaviate](https://github.com/cohere-ai/notebooks/blob/main/notebooks/guides/Wikipedia_search_demo_cohere_weaviate.ipynb) | Embed, Weaviate | Open In Colab | -## Summarization +### Summarization | Title | Components | Colab | |--------------------------------------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | [Long Form General Strategies](https://github.com/cohere-ai/notebooks/blob/main/notebooks/guides/Long_form_General_Strategies.ipynb) | Chat, Embed, Rerank | Open In Colab | @@ -128,7 +151,7 @@ This section provides a deep dive into various techniques in the following topic | [Grounded Summarization Using Command R](https://github.com/cohere-ai/notebooks/blob/main/notebooks/guides/Grounded_summarisation_using_Command_R.ipynb) | Chat, Embed | Open In Colab | -## Others +### Others | Title | Components | Colab | |--------------------------------------------------------------|-----------------------|------------------------------------------------------------------------| | [Advanced Document Parsing For Enterprises](https://github.com/cohere-ai/notebooks/blob/main/notebooks/guides/Document_Parsing_For_Enterprises.ipynb) | Chat, Embed, Rerank | Open In Colab | @@ -140,7 +163,7 @@ This section provides a deep dive into various techniques in the following topic
-# Contributing +## Contributing Thank you for your interest in contributing! We appreciate your input and encourage you to share your ideas and improvements. Here are some ways you can contribute: - New Examples and Guides: If you have an idea for a new example or guide, please share it with us! Create an issue to discuss your proposal, gather feedback, and get started. This ensures your contribution aligns with the project's scope and avoids duplication.