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()
Changing Base URL
You can change the base URL as such:
client.base_url = "https://.../latest"
You can also update the ingest base URL:
client.ingest_base_url = "https://.../latest
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.25.1.2022.1.5.11.42.29.429111.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bf6b9a4d0f864815afb593a0f0709bd9aef4e4a246d5119ac8f44243b418ce2 |
|
MD5 | 382c2c98b3dfaff9d6fd3a7feb6c5f1a |
|
BLAKE2b-256 | ff85d8ca94fb625a572eab0e7edd8e3c6020d2fefe7264000084c1e8986de0a2 |
Hashes for RelevanceAI_dev-0.25.1.2022.1.5.11.42.29.429111-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dc2f17c1ab939ae86c48ba76ca3658b56de3d37ae3cb9122bab5048d5465c79 |
|
MD5 | 128ac9a6afac651e361d85620bc2e9ca |
|
BLAKE2b-256 | 76620c2b631c54daff3be2b2ebe8d7f4aa6fd3c50f0053bb3f6e95ec5fd85f98 |