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.12.13.11.17.918983

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.12.13.11.17.918983
File Size Uploaded
RelevanceAI-dev-0.21.1.2021.12.12.13.11.17.918983.tar.gz 57.4 kB Details

Built distribution (wheel)

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

Total release size: 133.4 kB

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

Download URL RelevanceAI-dev-0.21.1.2021.12.12.13.11.17.918983.tar.gz
Size 57.4 kB
Tags Source
SHA-256 checksum
How to use checksums
77edeaff121b8d670b03153a1eac6ae5bd287d09d4dabc35da51a222fbb41391
BLAKE2b-256 checksum
How to use checksums
0d99c8a4ddb033aae1359b391961e8380d69c2b18a0d173668f2db89920a23ff
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.12.13.11.17.918983-py3-none-any.whl

Download URL RelevanceAI_dev-0.21.1.2021.12.12.13.11.17.918983-py3-none-any.whl
Size 76.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
61a02fbac7b26e3a21ae1cd7fe9b56bb68e73e68339af38ffc29a038f5561e4f
BLAKE2b-256 checksum
How to use checksums
7f5decab2d66c6271acfac9c18c79e63c5a667ebc31aeeda4fdb66688d5194d2
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