Skip to content
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

Add Quick Start to Readme #236

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add Quick Start to Readme #236

wants to merge 2 commits into from

Conversation

ai-yann
Copy link
Collaborator

@ai-yann ai-yann commented Oct 25, 2024

This PR introduces a restructured README file for the Cohere Examples repository, enhancing its organisation and clarity. The changes include:

  • Renaming Sections: The sections 'Getting Started', 'LLM University', 'Cookbook', 'RAG', 'Agents', 'Summarization', and 'Others' have been renamed to 'Quick Start', 'LLM University', 'Cookbook', 'RAG', 'Agents', 'Summarization', and 'Others', respectively.
  • Adding Subsections: The 'Quick Start' section now includes 'Installation' and 'Authentication' subsections, providing detailed instructions for setting up the Cohere Python SDK and authenticating with the CohMre API.
  • Prerequisites: A new 'Prerequisites' section has been added, listing the requirements for using the repository, including Python 3.7 or higher, a Cohere API key, and familiarity with Jupyter notebooks.
  • Consistent Formatting: The formatting of the README has been standardised, ensuring a consistent look and feel throughout the document.

### Authentication
```python
import cohere
co = cohere.Client('your-api-key') # Get your API key from dashboard.cohere.ai
Copy link
Contributor

Choose a reason for hiding this comment

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

to add both options - v1 and v2, with v2 as the preferred one.

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.

2 participants