Release v5.0.1

Fixed

• Fix RTD build. Docs for 5.0.0 are not available, but 5.0.1 docs are identical.

Release v5.0.0

Added

• Argument include_module=False for function misc.tname().
• New function plotting.percentage_ticks()

Fixed

• Handling of gh-101860 (new @property.__name__) under 3.13 in misc.tname() and misc.get_public_module().

Removed

• Module rics.ml.time_split. use the time-split package instead.

Release v4.1.1

Fixed

• Fix handling of paths.parse_any_path() bool-type postprocessors (raise on False).

Release v4.1.0

Added

• New module rics.paths; paths.parse_any_path(), derived functions any_path_to_str() and any_path_to_path().
• New module rics.strings. Moved format_perf_counter() and format_seconds().
• New function strings.format_bytes().
• New function rics.collections.dicts.format_changed_keys().

Deprecated

• Module rics.ml.time_split use time-split package instead.
• Functions rics.performance.format_perf_counter() and format_seconds(). Use rics.strings-functions instead.

Release v4.0.1

Fixed

• Fix RTD build. Docs for 4.0.0 are not available, but 4.0.1 docs are identical.

Release v3.3.0

Added

• The get_by_full_name() function has two new optional arguments instance_of and subclass_of, which may be
  used to ensure correct return types.
• The unflatten_dict() function now supports tuple keys.
• The logs.disable_temporarily() function now support passing loggers by name.

Fixed

• Print parent of inner class in misc.tname() when prefix_classname=True.
• Prefer later folds when using frequency-based schedule and after arguments (ml.time_split, #313).

Release v3.2.0

Added

• Add new step argument to ml.time_split splitting functions.
• Add new plot.REMOVED_FOLD_STYLE attribute to time_split.settings.

Fixed

• Update, fix and clarify some documentation issues.
• The misc.tname()-function now handles functools.partial properly (new argument attrs='func').

Release v3.1.0

Added

• New module rics.ml.time_split; successor to pandas.TimeFold.
• Function collections.dicts.unflatten_dict(); inverse of flatten_dict().
• Function misc.get_public_module(); resolve public module name of an object, optionally looking for reexports.
• Function misc.format_kwargs(); pretty-print keyword arguments.

Changed

• The flatten_dict()-function now takes a string_fn-argument (default=str).
• Update format used for durations in rics.performance.

Deprecated

• The rics.pandas.TimeFold class. Replaced by rics.ml.time_split.

Fixed

• Handle LoggerAdapter in logs.disable_temporarily().
• Handle improve handling of '{}' (e.g. Python fstrings) in envinterp.
• Handle properties in misc.tname.

Release v3.0.1

Changed

• Deprecated rics.mapping.

Fixed

• Fixed some minor TimeFold issues.
• TimeFold.make_sklearn_splitter.split and TimeFold.plot now handle datetime-like iterables correctly.

Release v3.0.0

Added

• The score_functions.disabled() function, used to force a Mapper to work in override-only mode.
• An optional argument for_value to the heuristic_functions.value_fstring_alias() function.
• The Mapper.copy()-method now accepts keyword override arguments.
• The envinterp module and misc.interpolate_environment_variables() function (replaces read_env_or_literal())

Changed

• Add n_splits argument to TimeFold (scikit-learn compatibility).
• Raise AmbiguousScoreError if match scores do not allow deterministic mapping.
• Add a small positional penalty in HeuristicScore, to favor alias functions that are defined early.
• Add a small positional penalty in modified_hamming, to favor candidates that are defined early.
• Reduce default value of Mapper.min_score (from 1.0 to 0.9).
• Updated Mapper verbosity flag to be consistent. Now called verbose_logging everywhere.

Fixed

• The heuristic_functions.candidate_fstring_alias() function may now properly use value and context placeholders.
• Properly raise exceptions in [value/candidate]_fstring_alias for invalid fstring arguments.
• Added missing checks in Mapper.__eq__().

Removed

• The misc.read_env_or_literal() function has been replaced by rics.misc.interpolate_environment_variables().