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 (only available on Linux environments at the moment): 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.1.2021.12.22.7.20.27.341601.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eca841db0e226a2423d765cd424eb29755ed858c16ad7b305e9aaf083dc3d7c4 |
|
MD5 | 0ec4d43c2e4d1bad318e0c848a635839 |
|
BLAKE2b-256 | b6e8e3c44f6cacc0fcaface966c66c82348053d9959d30f85a18647d6ee112f8 |
Hashes for RelevanceAI_dev-0.24.1.2021.12.22.7.20.27.341601-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a9f2a49ad0f07be2b8514cc6c3c0742610bbe930fcf082fa5c1fd2cd54557d3 |
|
MD5 | ef6f54d0beb1d3f44e692a180f590615 |
|
BLAKE2b-256 | 9e2db008257bea97d2b5aa265e9dbbf7172d7f12ab3ad0a86aef79f7c8a70c18 |