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.24.1.2021.12.22.2.24.33.937824.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 660bc6998584a7c14d8328716561ec5cca113b9a009780d1255c1996ec42ee4d |
|
MD5 | e45cd400141458116d0330345361c192 |
|
BLAKE2b-256 | 4dbb2f1cdf61bdac64626aa615c92712f3dbd28c94aa88ce8aff723e502d24b6 |
Hashes for RelevanceAI_dev-0.24.1.2021.12.22.2.24.33.937824-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a266b46f2d6c47ad12164b533ee94526bcfc63823669803bef9488f0af26a5c |
|
MD5 | e0e21882e3f9698db608357a29929c4e |
|
BLAKE2b-256 | e618c1a6df18c7102eeb4aec8cc72868288be2f2f1ad2df3023761b0ca62e6cb |