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.26.4.2022.1.9.4.20.34.426288.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40acff31201417c475ca6d13390d1830f5491c3a576cbdd8e1c84a9466e987c5 |
|
MD5 | 7604d720757dd1907b568637219cf49b |
|
BLAKE2b-256 | 26e95762f5269c7c12f50f60b79fd7442128632303324c6deb52a0925458ca25 |
Hashes for RelevanceAI_dev-0.26.4.2022.1.9.4.20.34.426288-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b06df7ca91d6b5b328bc8ae8e55f2c250c49a9d7dfdb6ee85ccbf788364cf048 |
|
MD5 | 2f7f264bfdd5c68b615de1622d7f91ed |
|
BLAKE2b-256 | 07f16f8d41a257a49876b95f6d9d374bae07b6672053504dc8ddc2be3cc71d2e |