Metadata-Version: 2.1
Name: RelevanceAI
Version: 0.25.2
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
Provides-Extra: dev
Provides-Extra: dev-vis
Provides-Extra: excel
Provides-Extra: vis
Provides-Extra: tests
Provides-Extra: notebook
Provides-Extra: umap
Provides-Extra: kmedoids
Provides-Extra: hdbscan
License-File: LICENSE

# 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://relevanceai.github.io/RelevanceAI/docs/html/index.html).

Built mainly for data scientists/engineers looking to experiment with vectors/embeddings.

## Installation 

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

You can also install on conda (only available on Linux environments at the moment): `conda install -c relevance relevanceai`.

## How to use the RelevanceAI 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
```

## Config

The config contains the adjustable global settings for the SDK. For a description of all the settings, see [here](https://relevanceai.github.io/RelevanceAI/docs/html/index.html).  

To view setting options, run the following:

```python
client.config.options
```

The syntax for selecting an option is *section.key*. For example, to disable logging, run the following to modify *logging.enable_logging*:

```python
client.config.set_option('logging.enable_logging', False)
```

To restore all options to their default, run the following:

```python
client.config.reset_to_default()
```

## Changing Base URL 

You can change the base URL as such: 

```
client.base_url = "https://.../latest"
```

You can also update the ingest base URL: 

```
client.ingest_base_url = "https://.../latest
```


