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()
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.13.15.58.298942.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 645e6750191aa8caf59f2c27cdd5a98431c90a12618b0c79b6f688447031aa0c |
|
MD5 | f9570ebc03fa1e3c19b11b504dd6e1ff |
|
BLAKE2b-256 | db82703e3cdbc26e8d33c420fe45cc860ec333de1c69a8d3620459e36864449e |
Hashes for RelevanceAI_dev-0.24.1.2021.12.22.13.15.58.298942-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cec3da5b51ad0e84f2e350b138f4045d1ed67d005e9ec86ca6bb6bf4fe45c5c |
|
MD5 | 477ef9dc394391f25ecab2d62ce782f8 |
|
BLAKE2b-256 | d07529e238c4c379c7d246a4f232976d2dd8ee555ed7f21a16b4b11993691ca8 |