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.19.22.9.33.678761.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a933864c5fea408f561b6000b0522cf6c0a759e523971045493a6a97e99e7211 |
|
MD5 | e8ac03fa8ef0e5cde74da525f1c4db67 |
|
BLAKE2b-256 | 3f86a90dffb553502b4a762f1506e17b855d6010e8966645ec5c0a418f68c8a6 |
Hashes for RelevanceAI_dev-0.23.3.2021.12.19.22.9.33.678761-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 555253774efc275dd5ddd9a95430e3fa6967d75b5294b9f5ff13796dedffafff |
|
MD5 | e09d6ebad6bc4fcfbb25add3d56d5282 |
|
BLAKE2b-256 | 977639e077556a1207456d6c0f69e8998dea8faa6536006b888619a3fe6638c7 |