From c775756972168f51b7265fb7f78670341160173c Mon Sep 17 00:00:00 2001 From: Ben Eagan Date: Mon, 24 Jun 2024 13:58:04 -0400 Subject: [PATCH] Add contribution guideline and README --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 16 +++++++++++++++- 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b465109 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index 2add4e2..84bbaea 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # Cohere Compass SDK -WIP \ No newline at end of file +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)