Add initial change log

CHANGELOG.md

@@ -1,9 +1,117 @@
 # Changelog
 
-## 0.0.5 
+## v1.0.0 (2023-12-06) 
 
-### Features:
-- tba
+### Improvements/Changes
+
+* **tracking**:
+   * Improve (under-the-hoood) tracking interfaces, introducing the concept of a tracking
+     context (class `TrackingContext`, which is typically model-specific) in addition to the more
+     high-level 'experiment' concept
+   * Full support for cross-validation
+   * Adapt & improve MLflow tracking implementation
+* **util.datastruct**:
+    * `SortedKeysAndValues`, `SortedKeyValuePairs`: Add `__len__`
+* **featuregen**:
+    * `FeatureCollector`: Add factory methods for the generation of
+      DFTNormalisation and DFTOneHotEncoder instances (for convenience)
+    * `FeatureGeneratorRegistry`:
+        * Improve type annotation of singleton dictionary
+        * Add convenience method `collect_features`, which creates a
+          FeatureCollector
+* **util.io**:
+    * `write_data_frame_csv_file`: Add options `index` and `header`
+* **util.pickle**:
+    * `dump_pickle`, `load_pickle`: `PickleLoadSaveMixin`: Support passing `Path` objects
+* **vector_model**:
+    * `TorchVector*Model`:
+      * Improve type hints for with* methods
+    *  Pre-processors are now included in models string representations by default 
+* **evaluation**:
+    * `MultiDataModelEvaluation` (previously `MultiDataEvaluationUtil`):
+       * Add model description/string representation to result object
+    * Add class `CrossValidationSplitterNested` (for nested cross-validation)
+    * `ModelComparisonData.Result`: Add method `iter_evaluation_data`
+* **feature_selection**:
+    * Add `RecursiveFeatureElimination` (to complement existing CV-based implementation)
+* **util.string**:
+    * Add class `TagBuilder` (for generation of dataset/experiment tags/identifiers)
+* **util.logging**:
+    * Add in-memory logging (`add_memory_logger`, `get_memory_log`)
+    * Reuse configured log format (if any) for both file & in-memory loggers
+    * Add functions `run_main` and `run_cli` for convenient setup
+    * Add `set_configure_callback` for third-party usage of `configure`, allowing
+      users to add additional configuration via a callback
+    * Add `remove_log_handler`
+    * Add `FileLoggerContext` for file-based logging within a `with`-block
+* **Refactoring**:
+    * Module `featuregen` is now a package with modules
+       * `feature_generator` (all feature generators)
+       * `feature_generator_registry` (registry and feature collector) 
+* **Testing**:
+    * Add test for typical usage of `FeatureCollector` in conjunction with
+      `FeatureGeneratorRegistry`  
+
+### Breaking Changes
+
+* Changed *all* camel case interfaces (methods and parameters) as well as
+  local variables to use snake case in order to align more closely with PEP 8.
+
+  This breaks source-level compatibility with earlier v0 releases.
+  However, persisted objects from earlier versions should still be loadable,
+  as attribute names in classes that may have been persisted remain in
+  camel case. Strictly speaking, PEP 8 makes no statement about the
+  format of attribute names, so there is not really a violation anyway.
+*  Removed some deprecated interfaces (particularly support for the
+   kwargs/dict interface in parallel to parameter objects in evaluators)
+* **FeatureGeneratorRegistry**:
+  Removed support for discouraged mechanism of setting/getting feature
+  generator factories via `__setattr__`/`__getattr__`
+* **NNOptimiserParams**: Do not use kwargs for parameters to be passed on 
+  to the underlying optimiser, use dict `optimiser_args` instead
+* **MultiDataModelEvaluation** (previously **MultiDataEvaluationUtil**):
+  * Moved evaluator and cross-validator params to constructor
+  * Removed deprecated method compare_models_cross_validation
+* **RegressionEvalStats**: Rename methods using inappropriate prefix `get` (now `compute`)
+* Renamed high-level evaluation classes:
+   * `RegressionEvalUtil` renamed to `RegressionModelEvaluation`
+   * `ClassificationEvalUtil` renamed to `ClassificationModelEvaluation`
+   * `MultiDataEvaluationUtil` renamed to `MultiDataModelEvaluation`
+   * `Vector*ModelEvaluatorParams` -> `*EvaluatorParams`
+* Changed default parameters of `SkLearnDecisionTreeVectorClassificationModel`
+  and `SkLearnRandomForestVectorClassificationModel` to align with sklearn
+  defaults
+
+### Fixes
+
+* **ToStringMixin**:
+  Prevent infinite recursion for case where ToStringMixin references a bound
+  method of itself
+* **TorchVectorModels**: Dropped support for model kwargs in constructor
+* **MultiDataModelEvaluation** (previously **MultiDataEvaluationUtil**): 
+  * dataset key column was not removed prior to mean computation (would fail if 
+    value is non-numeric)
+  * Combined eval stats were not logged
+* **EvalStatsClassification**: Do not attempt to create precision/recall plots if
+  class probabilities are unavailable
+
+## v0.2.0 (2023-07-20)
+
+Final pre-release (primarily for internal use at jambit GmbH
+and appliedAI Initiative GmbH)
+
+
+## Earlier Pre-Releases (2020-2022)
+
+* v0.1.9 (2022-07-20)
+* v0.1.8 (2022-07-01)
+* v0.1.7 (2022-02-22)
+* v0.1.6 (2021-07-16)
+* v0.1.5 (2021-06-22)
+* v0.1.4 (2021-06-21)
+* v0.1.1 (2021-06-01)
+* v0.1.0 (2021-05-25)
+* v0.0.8 (2021-02-18)
+* v0.0.4 (2020-10-16)
+* v0.0.1 (2020-02-20)
 
-### Development:
-- Improved docu, build and release mechanism