Skip to main content

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 users looking to experiment with vectors/embeddings.

Installation

The easiest way is to install this package is to run pip install --upgrade 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()

Release files for RelevanceAI-dev 0.21.1.2021.12.13.0.10.6.864783

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for RelevanceAI-dev 0.21.1.2021.12.13.0.10.6.864783
File Size Uploaded
RelevanceAI-dev-0.21.1.2021.12.13.0.10.6.864783.tar.gz 59.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for RelevanceAI-dev 0.21.1.2021.12.13.0.10.6.864783
File Interpreter ABI Platform
RelevanceAI_dev-0.21.1.2021.12.13.0.10.6.864783-py3-none-any.whl Python 3 none any Details

Total release size: 139.8 kB

Release files / RelevanceAI-dev-0.21.1.2021.12.13.0.10.6.864783.tar.gz

Download URL RelevanceAI-dev-0.21.1.2021.12.13.0.10.6.864783.tar.gz
Size 59.5 kB
Tags Source
SHA-256 checksum
How to use checksums
646f2608b35461ac3087ac95d6df79604160a60d238f6dd82b14d15597ad2142
BLAKE2b-256 checksum
How to use checksums
6a4e7c7f1e38be5d714fbfbb9da40f6cdb6ef017b104c84ea1426639f75a7a84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release files / RelevanceAI_dev-0.21.1.2021.12.13.0.10.6.864783-py3-none-any.whl

Download URL RelevanceAI_dev-0.21.1.2021.12.13.0.10.6.864783-py3-none-any.whl
Size 80.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
13b45f6e31d59af726ad099bd0837668acf97add908c7f5391fb78cced983f79
BLAKE2b-256 checksum
How to use checksums
44e1de77df5cead10dfc548bc95450b87863378742dae5879ffdbd2ed07fdf95
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release history Release notifications | RSS feed

This release

0.17.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page