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.5.2021.12.21.3.25.49.45254.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4374c5e4170de00df1f13803b4c33aef06efca7dae0ef852d45d28ed0bb3a9cf |
|
MD5 | 93e356b2c9be9685f165b3a7b8b8e470 |
|
BLAKE2b-256 | 4341f3d17fde46582ce8ae72d87a1191ea946f4ec2a3735855ec085c84d69bc2 |
Hashes for RelevanceAI_dev-0.23.5.2021.12.21.3.25.49.45254-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 052aeeb37182dbe539c895f57a1b74edab8bd18b560a1e5cb520ac506f3e1d70 |
|
MD5 | 87a64bd0a5df58a7b0ef3b5c83dbcd90 |
|
BLAKE2b-256 | 8b5c07dcf78e8d8e8c1ae3238925b9802890f001f2ee6d52e24ce3fa2e3177ad |