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.0.2022.1.5.5.50.50.432966.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1633bc1d0f1978d9a16074c1ec3dfcb18f5bd331274b92e7ec18a5a3428b71f |
|
MD5 | 84134c4f2789e642c351ce2b25e11c89 |
|
BLAKE2b-256 | 4609ff4b6c34b96a81497fef0be64d25f2f77b279763b40b2daad5418f2dd24a |
Hashes for RelevanceAI_dev-0.25.0.2022.1.5.5.50.50.432966-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b81d53d0d2ac3ea7c4888a7db8a36973d2bbabb27778524d384d0f6efc261300 |
|
MD5 | 23b565a6c2a80cf0d617b257c46a7575 |
|
BLAKE2b-256 | 8eb75066a3d7296230b46c4b107d26ddfc54ba4025120a25be0b53c20ff10051 |