CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

v1.3.0 - 2021-02-24 - competitors and improved transformation

general:

• release of official MLAir logo (#274 (closed))
• new transformation schema for better independence of MLAir and data handler (#272 (closed))
• competing models can be included in postprocessing for direct comparison (#198 (closed))

new features:

• new helper functions for geographic issues (#280 (closed))
• default data handler and inheritances can use min/max and log transformation (#276 (closed), #275 (closed))
• include IntelliO3-ts model as reference via automatic download (#131 (closed))

technical:

• experiment name now always includes target sampling type (#263 (closed))
• competitive skill score plot is refactored (#260 (closed))
• bug fix for climatological skill scores (#259 (closed))
• bug fix for custom objects handling (#277 (closed))
• bug fix for monitoring plots when multiple output branches are used (#278 (closed))
• update requirements to newer version and dependencies (#262 (closed), #273 (closed))
• HPC scripts are updated to work properly with parallel data processing (#281 (closed))

v1.2.1 - 2021-02-08 - bug fix for recursive import error

general:

• applied bug fix

technical:

• bug fix for recursive import error, (#269 (closed))

v1.2.0 - 2020-12-18 - parallel preprocessing and improved data handlers

general:

• new plots
• parallelism for faster preprocessing
• improved data handler with mixed sampling types
• enhanced test coverage

new features:

• station map plot highlights now subsets on the map and displays number of stations for each subset (#227 (closed), #231 (closed))
• two new data availability plots PlotAvailabilityHistogram (#191 (closed), #192 (closed), #223 (closed))
• introduced parallel code in preprocessing if system supports parallelism (#164 (closed), #224 (closed), #225 (closed))
• data handler DataHandlerMixedSampling (and inheritances) supports an offset parameter to end inputs at a different time than 00 hours (#220 (closed))
• args for data handler DataHandlerMixedSampling (and inheritances) that differ for input and target can now be parsed as tuple (#229 (closed))

technical:

• added templates for release and bug issues (#189 (closed))
• improved test coverage (#236 (closed), #238 (closed), #239 (closed), #240 (closed), #241 (closed), #242 (closed), #243 (closed), #244 (closed), #245 (closed))
• station map plot includes now number of stations for each subset (#231 (closed))
• postprocessing plots are encapsulated in try except statements (#107 (closed))
• updated git settings (#213 (closed))
• bug fix for data handler (#235 (closed))
• reordering and bug fix for preprocessing reporting (#207 (closed), #232 (closed))
• bug fix for outdated system path style (#226 (closed))
• new plots are included in default plot list (#211 (closed))
• helpers/join connection to ToarDB (e.g. used by DefaultDataHandler) reports now which variable could not be loaded (#222 (closed))
• plot PlotBootstrapSkillScore can now additionally highlight specific variables, but not included in postprocessing up to now (#201 (closed))
• data handler DataHandlerMixedSampling has now a reduced data loading (#221 (closed))

v1.1.0 - 2020-11-18 - hourly resolution support and new data handlers

general:

• MLAir can be used with 1H resolution data from JOIN
• new data handlers to use the Kolmogorov-Zurbenko filter and mixed sampling types

new features:

• new data handler DataHandlerKzFilter to use Kolmogorov-Zurbenko filter (kz filter) on inputs (#195 (closed))
• new data handler DataHandlerMixedSampling that can used mixed sampling types for input and target (#197 (closed))
• new data handler DataHandlerMixedSamplingWithFilter that uses kz filter and mixed sampling (#197 (closed))
• new data handler DataHandlerSeparationOfScales to filter-depended time steps sizes on filtered inputs using mixed sampling (#196 (closed))

technical:

• bug fix for very short time series in TimeSeriesPlot (#215 (closed))
• bug fix for variable dictionary when using hourly resolution (#212 (closed))
• variable naming for data from JOIN interface harmonised (#206 (closed))
• transformation setup is now separated for inputs and targets (#202 (closed))
• bug fix in PlotClimatologicalSkillScore if only single station is used (#193 (closed))
• preprocessed data is now stored inside experiment and not in the data folder

v1.0.0 - 2020-10-08 - official release of new version 1.0.0

general:

• This is the first official release of MLAir ready for use
• updated license, installation instruction

technical:

• restructured order of packages in requirements

v0.12.2 - 2020-10-01 - HDFML support

general:

• HDFML support

technical:

• installation script for HDFML adjusted, #183 (closed)

v0.12.1 - 2020-09-28 - examples in notebook

general:

• introduced a notebook documentation for easy starting, #174 (closed)
• updated special installation instructions for the Juelich HPC systems, #172 (closed)

new features:

• names of input and output shape are renamed consistently to: input_shape, and output_shape, #175 (closed)

technical:

• it is possible to assign a custom name to a run module (e.g. used in logging), #173 (closed)

v0.12.0 - 2020-09-21 - Documentation and Bugfixes

general:

• improved documentation include installation instructions and many examples from the paper, #153 (closed)
• bugfixes (see technical)

new features:

• MyLittleModel is now a pure feed-forward network (before it had a CNN part), #168 (closed)