rics

My personal little ML engineering library.

Environment variables

JTWILI

Set JTWILI=true to disable the warning emitted by rics.configure_stuff().

Functions

configure_stuff([level, rics_level, ...])

Configure a bunch of stuff to match my personal preferences.

Classes

ConfigureStuff()

Magical return type of configure_stuff().

class ConfigureStuff

Bases: object

Magical return type of configure_stuff(). The same caveats apply.

property configured: list[str]

Things that were configured.

configure_stuff(level: int | str = 'INFO', rics_level: int | str = 'INFO', id_translation_level: int | str = 'INFO', matplotlib_level: int | str = 'WARNING', logging: bool = True, pandas: bool = True, plotting: bool = True, **kwargs: Any) → ConfigureStuff

Configure a bunch of stuff to match my personal preferences. May do strange stuff 👻.

Warning

This function can and will change without warning, and will not be documented in the changelog. Don’t use for anything important.

Set JTWILI=true to disable the warning.

Parameters:

• level – Log level for the root logger. Default is logging.INFO.

• rics_level – Log level for the rics package. Default is logging.INFO.

• id_translation_level – Log level for the id_translation package. Default is logging.INFO.

• matplotlib_level – Log level for the matplotlib package. Default is logging.WARNING.

• logging – If True, attempt to perform logging configuration.

• pandas – If True, attempt to perform pandas configuration.

• plotting – If True, attempt to perform plotting (e.g. matplotlib) configuration.

• **kwargs – Keyword arguments for rics.logs.basic_config() and logging.basicConfig().

Modules

action_level	Action level enumeration types.
cli	CLI entrypoint.
click	Utility functions and classes for working with https://pypi.org/project/click/ CLI applications.
collections	Collection utilities.
env	Utilities for working with environment variables.
envinterp	Legacy module.
jupyter	Utilities for working with Jupyter.
logs	Utility methods for logging tasks.
misc	Miscellaneous utility methods for Python applications.
paths	Utility methods for working with paths and filesystems.
performance	Performance testing utility.
plotting	Plotting utility methods.
strings	Utility functions that act on or produce strings.
types	Types used by this package.