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: 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()
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.22.1.2021.12.15.6.29.32.846684.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31157feb20c52831e9647c973cdb68b4a17b4573a0466683b0996382859930c5 |
|
MD5 | 1bd476db7b16fbc7b4eef9a4ab76d421 |
|
BLAKE2b-256 | 4915e48f82450e4f47642eb87e981e9dd8b57ed4ac3f0de6dce6eda39d384862 |
Hashes for RelevanceAI_dev-0.22.1.2021.12.15.6.29.32.846684-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec9215564ce5ec3e08c9ce311685152a2c5830cee485100ded9450a7d19fedd6 |
|
MD5 | df6ab4f3784b285a963fd3f6018cd763 |
|
BLAKE2b-256 | 62f7b590505967f863804c6877a6ac5350a7befb5d29668f19cf7d14e40e3e91 |