Metadata-Version: 2.1
Name: RelevanceAI-dev
Version: 0.18.6.2021.12.2.23.37.45.441419
Summary: UNKNOWN
Home-page: https://relevance.ai/
Author: Relevance AI
Author-email: dev@relevance.ai
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Database
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
Classifier: Topic :: Multimedia :: Video :: Conversion
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tqdm (>=4.49.0)
Requires-Dist: pandas (>=1.0.0)
Requires-Dist: loguru (>=0.5.3)
Requires-Dist: document-utils (>=1.3.0)
Requires-Dist: requests (>=2.0.0)
Requires-Dist: numpy (>=1.19.0)
Provides-Extra: dev
Requires-Dist: autopep8 ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: jupyter ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (>=0.5.0) ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-dotenv ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'
Requires-Dist: openpyxl (>=3.0.9) ; extra == 'dev'
Requires-Dist: fsspec (>=2021.10.1) ; extra == 'dev'
Requires-Dist: scikit-learn ; extra == 'dev'
Requires-Dist: plotly (>=5.3.1) ; extra == 'dev'
Requires-Dist: typing-extensions ; extra == 'dev'
Requires-Dist: typeguard ; extra == 'dev'
Requires-Dist: umap-learn (>=0.5.2) ; extra == 'dev'
Requires-Dist: ivis[cpu] (>=2.0.6) ; extra == 'dev'
Requires-Dist: ivis[gpu] (>=2.0.6) ; extra == 'dev'
Requires-Dist: scikit-learn-extra (>=0.2.0) ; extra == 'dev'
Requires-Dist: hdbscan (>=0.8.27) ; extra == 'dev'
Provides-Extra: dev-vis
Requires-Dist: autopep8 ; extra == 'dev-vis'
Requires-Dist: pylint ; extra == 'dev-vis'
Requires-Dist: jupyter ; extra == 'dev-vis'
Requires-Dist: sphinx-rtd-theme (>=0.5.0) ; extra == 'dev-vis'
Requires-Dist: pytest ; extra == 'dev-vis'
Requires-Dist: pytest-dotenv ; extra == 'dev-vis'
Requires-Dist: pytest-cov ; extra == 'dev-vis'
Requires-Dist: pytest-mock ; extra == 'dev-vis'
Requires-Dist: mypy ; extra == 'dev-vis'
Requires-Dist: types-requests ; extra == 'dev-vis'
Requires-Dist: openpyxl (>=3.0.9) ; extra == 'dev-vis'
Requires-Dist: fsspec (>=2021.10.1) ; extra == 'dev-vis'
Requires-Dist: scikit-learn ; extra == 'dev-vis'
Requires-Dist: plotly (>=5.3.1) ; extra == 'dev-vis'
Requires-Dist: typing-extensions ; extra == 'dev-vis'
Requires-Dist: typeguard ; extra == 'dev-vis'
Requires-Dist: umap-learn (>=0.5.2) ; extra == 'dev-vis'
Requires-Dist: ivis[cpu] (>=2.0.6) ; extra == 'dev-vis'
Requires-Dist: ivis[gpu] (>=2.0.6) ; extra == 'dev-vis'
Requires-Dist: scikit-learn-extra (>=0.2.0) ; extra == 'dev-vis'
Requires-Dist: hdbscan (>=0.8.27) ; extra == 'dev-vis'
Provides-Extra: excel
Requires-Dist: openpyxl (>=3.0.9) ; extra == 'excel'
Requires-Dist: fsspec (>=2021.10.1) ; extra == 'excel'
Provides-Extra: hdbscan
Requires-Dist: hdbscan (>=0.8.27) ; extra == 'hdbscan'
Provides-Extra: ivis-cpu
Requires-Dist: ivis[cpu] (>=2.0.6) ; extra == 'ivis-cpu'
Provides-Extra: ivis-gpu
Requires-Dist: ivis[gpu] (>=2.0.6) ; extra == 'ivis-gpu'
Provides-Extra: kmedoids
Requires-Dist: scikit-learn-extra (>=0.2.0) ; extra == 'kmedoids'
Provides-Extra: notebook
Requires-Dist: jsonshower ; extra == 'notebook'
Requires-Dist: scikit-learn ; extra == 'notebook'
Requires-Dist: plotly (>=5.3.1) ; extra == 'notebook'
Requires-Dist: typing-extensions ; extra == 'notebook'
Requires-Dist: typeguard ; extra == 'notebook'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-dotenv ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-mock ; extra == 'tests'
Requires-Dist: mypy ; extra == 'tests'
Requires-Dist: types-requests ; extra == 'tests'
Requires-Dist: openpyxl (>=3.0.9) ; extra == 'tests'
Requires-Dist: fsspec (>=2021.10.1) ; extra == 'tests'
Requires-Dist: scikit-learn ; extra == 'tests'
Requires-Dist: plotly (>=5.3.1) ; extra == 'tests'
Requires-Dist: typing-extensions ; extra == 'tests'
Requires-Dist: typeguard ; extra == 'tests'
Requires-Dist: umap-learn (>=0.5.2) ; extra == 'tests'
Requires-Dist: ivis[cpu] (>=2.0.6) ; extra == 'tests'
Requires-Dist: ivis[gpu] (>=2.0.6) ; extra == 'tests'
Requires-Dist: scikit-learn-extra (>=0.2.0) ; extra == 'tests'
Requires-Dist: hdbscan (>=0.8.27) ; extra == 'tests'
Provides-Extra: umap
Requires-Dist: umap-learn (>=0.5.2) ; extra == 'umap'
Provides-Extra: vis
Requires-Dist: scikit-learn ; extra == 'vis'
Requires-Dist: plotly (>=5.3.1) ; extra == 'vis'
Requires-Dist: typing-extensions ; extra == 'vis'
Requires-Dist: typeguard ; extra == 'vis'
Provides-Extra: vis-all
Requires-Dist: scikit-learn ; extra == 'vis-all'
Requires-Dist: plotly (>=5.3.1) ; extra == 'vis-all'
Requires-Dist: typing-extensions ; extra == 'vis-all'
Requires-Dist: typeguard ; extra == 'vis-all'
Requires-Dist: umap-learn (>=0.5.2) ; extra == 'vis-all'
Requires-Dist: ivis[cpu] (>=2.0.6) ; extra == 'vis-all'
Requires-Dist: ivis[gpu] (>=2.0.6) ; extra == 'vis-all'
Requires-Dist: scikit-learn-extra (>=0.2.0) ; extra == 'vis-all'
Requires-Dist: hdbscan (>=0.8.27) ; extra == 'vis-all'

# RelevanceAI

For guides, tutorials on how to use this package, visit https://docs.relevance.ai/docs.

If you are looking for an SDK reference, you can find that [here](https://youthful-leakey-ab1977.netlify.app/index.html).

Built mainly for users looking to experiment with vectors/embeddings.

## Installation 

The easiest way is to install this package is to run `pip install --upgrade relevanceai`.

## How to use the RelevanceAI client

For the relevanceai client, we want to ensure the SDK mirrors the API client.

For example:

```python
## To instantiate the client 
from relevanceai import Client
client = Client()
```

## Development

### Getting Started

To get started with development, ensure you have `pytest` and `mypy` installed. These will help ensure typechecking and testing.

```python
python -m pip install pytest mypy
```


Then run testing using:

Make sure to set your test credentials!

```
export TEST_PROJECT = xxx 
export TEST_API_KEY = xxx 
```

```python
python -m pytest
mypy relevanceai
```


