-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contribution guideline and README
- Loading branch information
Showing
2 changed files
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# OSS Toolkit Contributing Guide | ||
|
||
Thank you for your interest in contributing to Cohere's Compass SDK. This guide will help explain the contribution workflow from opening an issue, creating a PR, to reviewing and merging your added changes. | ||
|
||
## How to Contribute | ||
|
||
1. Ensure your change has an issue! Find an existing issue or open a new issue. | ||
- This is where you can get a feel if the change will be accepted or not. | ||
2. Once approved, fork this repository in your own GitHub account. | ||
3. [Fork this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) | ||
4. Make your changes on your fork and make sure all your [commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)! | ||
5. [Submit the fork as a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch this repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,17 @@ | ||
# Cohere Compass SDK | ||
|
||
WIP | ||
The Compass SDK is a Python library that allows you to parse documents and insert them into a Compass index. | ||
|
||
In order to parser documents, the Compass SDK relies on the Compass Parser API, which is a RESTful API that | ||
receives files and returns parsed documents. The parser API is provided as a dockerized service that can be | ||
deployed locally or in the cloud. | ||
|
||
The Compass SDK provides a `CompassParserClient` that allows to interact with the parser API from your | ||
Python code in a convenient manner. The `CompassParserClient` provides methods to parse single and multiple | ||
files, as well as entire folders, and supports multiple file types (e.g., `pdf`, `docx`, `json`, `csv`, etc.) as well | ||
as different file systems (e.g., local, S3, GCS, etc.). | ||
|
||
To insert parsed documents into a `Compass` index, the Compass SDK provides a `CompassClient` class that | ||
allows to interact with a Compass API server. The Compass API is also a RESTful API that allows to create, | ||
delete and search documents in a Compass index. To install a Compass API service, please refer to the | ||
[Compass documentation](https://github.com/cohere-ai/compass) |