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.5.55.31.124679.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3e70392ef8bc089f139c3f5b48c3fda3b83695aff35ecff7ca6ff7049ae602e |
|
MD5 | b71aaee5b31d4949b027a4d68fa8530f |
|
BLAKE2b-256 | e54dc8ee44fdc836743651710551a488decc9fb21cc1a2dda68848e8b4bed1ef |
Hashes for RelevanceAI_dev-0.23.5.2021.12.21.5.55.31.124679-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 075a187d213f9016e42d17c14f1c79628ab985df6d9d1b104f5606a447e1340a |
|
MD5 | 2273f7baade8431f99619930c17a0653 |
|
BLAKE2b-256 | a7ecafe0875193a94d592a5d6c028730a0bfc563ea885c858fc42ecd089a95b8 |