sensai-utils

1.6.0 · active · verified Wed Apr 15

sensai-utils is a Python library providing general-purpose utilities extracted from the larger sensAI project. It allows users to leverage various helper functions and classes (e.g., for caching, logging, data structures) without incurring the additional dependencies of the full sensAI library. The current version is 1.6.0, with minor version releases occurring regularly.

Warnings

gotcha The PyPI package name is `sensai-utils`, but the Python import path is `sensai.utils`. Attempting to import `sensai_utils` directly will result in an `ImportError`.
Fix: Always use `from sensai.utils...` for imports.
gotcha `sensai-utils` is a subset of the larger `sensAI` library, specifically designed to be used without `sensAI`'s full set of dependencies. While its utilities are general-purpose, for deep AI-related functionalities, consider installing the full `sensAI` library.
Fix: Understand that `sensai-utils` is a standalone utility package; if you need AI-specific features, refer to the `sensAI` library documentation.
gotcha Documentation for `sensai-utils`'s `util` package is integrated into the main `sensAI` documentation. Users looking for detailed usage examples and API references should consult the `sensAI` documentation for the `util` package.
Fix: Refer to the `sensAI` project's official documentation for comprehensive details on `sensai.utils` usage.

Install

pip install sensai-utils Install with pip

Imports

configure
wrong:
```
import sensai_utils.logging
```
correct:
```
from sensai.utils.logging import configure
```
The PyPI package `sensai-utils` exposes its functionality under the `sensai.utils` namespace, not `sensai_utils` directly. Always refer to `sensai.utils`.
ToStringMixin
```
from sensai.utils.string import ToStringMixin
```
Example of importing a utility class for string conversion.

Quickstart

This quickstart demonstrates configuring the logging utility from `sensai.utils.logging`. It sets up a basic logger to write informational messages to a file.

from sensai.utils.logging import configure
import logging
import os

# Configure a basic logger for demonstration
log_file_path = os.path.join(os.getcwd(), 'sensai_utils_quickstart.log')
configure(log_file_path=log_file_path, verbosity=logging.INFO)

logger = logging.getLogger(__name__)
logger.info('sensai-utils logging configured successfully!')

print(f"Log messages written to: {log_file_path}")

view raw JSON →