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.2.2022.1.5.23.58.0.717002.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe31742e789a8e4742238caf789c0196446de600ff04ac36d213ac41912de4cc |
|
MD5 | 90852faab71993e6d7887bb158fe3be7 |
|
BLAKE2b-256 | 5dec45c7eaaf8da34f13a2774af180009f1f0263ca24eea2c82d92c3687d79e1 |
Hashes for RelevanceAI_dev-0.25.2.2022.1.5.23.58.0.717002-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdd21ffc7254b7e88e31daf628be6c93f1cd5ec4cc4177078fb8e119aa982c97 |
|
MD5 | cb0dbbaed69e37717103b730c44b3fc5 |
|
BLAKE2b-256 | 91f85e17740b4f0f1422f5f2ea03c8a72986cc1d019d6ca69818be467253b124 |