No project description provided
Project description
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.
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: conda install -c relevance relevanceai
.
How to use the RelevanceAI client
For example:
## 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 -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 -m pytest
mypy relevanceai
Config
The config contains the adjustable global settings for the SDK. For a description of all the settings, see here.
To view setting options, run the following:
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:
client.config.set_option('logging.enable_logging', False)
To restore all options to their default, run the following:
client.config.reset_to_default()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for RelevanceAI-dev-0.23.3.2021.12.20.2.42.0.939651.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 344a4a7a8f20d3a6b03d2c457c159628b83f212761e323bc94d62957e5db0e0f |
|
MD5 | 377bcbcc6c0924adc727b738c4656118 |
|
BLAKE2b-256 | 98ce4cb713912bd7be6068503db74012853397a6e36aad466e968c21443d9347 |
Hashes for RelevanceAI_dev-0.23.3.2021.12.20.2.42.0.939651-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fb17dfcb3f00027ea54cae21e0fd16f98333d1fab5b417d9421ff0191e2b5db |
|
MD5 | 1a517caea6832aeafa5d63ffbc08ff8b |
|
BLAKE2b-256 | f8ae537a9122e43958f45acf45755335c2f0277ade6c7b35ae81dd9ba937dd81 |