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.24.0.2021.12.21.6.3.41.963869.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ebd2dc7e86a17a588191bd6ba30ab318ad414d5da2b1ca38ff2da1ae88e686b |
|
MD5 | 74a15762551ab3ed7580ae0893bfd3e0 |
|
BLAKE2b-256 | dcd81cef4b21199f4e5da8048e7a946218bc00782e34b9806e3d1019c2e63060 |
Hashes for RelevanceAI_dev-0.24.0.2021.12.21.6.3.41.963869-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f35574f78482c1090502b7b08094289c6fde34a177f81af96fa3ca1d8c3ee60d |
|
MD5 | e3e21206d00b72f9a024bb2b656cb575 |
|
BLAKE2b-256 | 7d47b62761a8f772649cda0c1aee2b904821e7984de356227900131e111fc4f7 |