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.22.0.2021.12.15.3.6.20.522390.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8aa4fb0a665ab481a9d2dc358edb706c9548aa1f858928fbf7f3bf0ebd2bfdc |
|
MD5 | ed8c3d70503d9364fe4c7dc4ec41c037 |
|
BLAKE2b-256 | 2f488c3f3de8c6041f0478eb4d58c3a0981f8dbe47ae64b1caac62bbf57c0d79 |
Hashes for RelevanceAI_dev-0.22.0.2021.12.15.3.6.20.522390-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e4380ed6f33b12aa3fae7519a237b50c518f4541ad51af9059f6b149796b38d |
|
MD5 | 25076cf22623fb888f6ca4390ad9946d |
|
BLAKE2b-256 | a954637e7772f56ec096b66dbe36824c9be28a858293b4a0fcfcda62bf84ebfd |