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.24.9.2022.1.4.4.9.49.266205.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c04f2ea4a876c27594d3b712fe3a4df1e89fe314f6b01b89c58e6917b745628 |
|
MD5 | 3e54b35988dd429ee8cb338627dd6bff |
|
BLAKE2b-256 | 2dd14d31d429206e69640d24a9d3f3eda90a308796dd384fa020c9c8d4fcd91a |
Hashes for RelevanceAI_dev-0.24.9.2022.1.4.4.9.49.266205-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bcb230f33fb9f17594e378d02acb969b20d211a0fb24148a57c789e1e018186 |
|
MD5 | f4771ecb8c1ae35c931210cc44fd608a |
|
BLAKE2b-256 | 870461e0ba937d217d6279111e93cdebfb902a67b61c5757ce62f77f06f6dd93 |