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 (only available on Linux environments at the moment): 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.24.1.2021.12.22.6.47.37.898495.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39f3768f904941639a7a0240489b99d41700042511c7e0eb76798761dfaf406e |
|
MD5 | 1053727d6ea3086d9139b3f2aaf0ee98 |
|
BLAKE2b-256 | bac37e8f74df6005f75c62934d1e85732f1822d4ab918b3c14c6717dba2c7f5e |
Hashes for RelevanceAI_dev-0.24.1.2021.12.22.6.47.37.898495-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0beaecedfcb139a7756c35ff14d35327df18c52748d4b1cb97b33754a397b62 |
|
MD5 | 4b2f300053fc155ce65019cbd859989f |
|
BLAKE2b-256 | 238652e4ed04caac65b8b66cacbe5f32fd92b3e935fa0ddd964f96f4cc0db9b5 |