v1.5.3

Resolved requests from reviewers JOSS:

• Fixes TOC header sphinx-gallery (#274)
• paper.md: Added DOI of Optuna reference in paper

What's Changed

• Sphinx Gallery problem with TOC headers by @mpvanderschelling in #275
• update version number to 1.5.3 by @mpvanderschelling in #276

Full Changelog: v1.5.2...v1.5.3

v1.5.2

Major changes

• Restricted numpy<2.0.0 from requirements.txt
• Minor linting fixes

What's Changed

Full Changelog: v1.5.1...v1.5.2

v.1.5.1

Major changes

• Small bugfixes and typos

What's Changed

• Pr/1.5.1 by @mpvanderschelling in #267

Full Changelog: v.1.5.0...v1.5.1

v.1.5.0

Major changes

• Refactoring and removing of legacy code
• Change how hyperparameters are handled; they now need to be given as initialization key-word arguments
• Major rework on optimization functionality
• Rework on JOSS paper draft

What's Changed

• Pr/1.5 by @mpvanderschelling in #266

Full Changelog: v.1.4.8...v.1.5.0

v.1.4.8

Major Changes

• Dropped compatibility with Python 3.7
• Added Sphinx Gallery for documentation examples
• added examples/ folder with code snippets explaining the functionality of f3dasm
• added Experimentdata.join method
• Change _Store class to public: StorageProtocol
• Added 2 benchmark studies: Fragile becomes supercompressible and Optimization benchmark

What's Changed

• Pull changes from 1.4.71 to branch 1.pr/4.8 by @mpvanderschelling in #264
• Pr/1.4.8 by @mpvanderschelling in #265

Full Changelog: v.1.4.71...v.1.4.8

v.1.4.71

Bugfix:

• autosummary documentation not build because of conflicting submodule name.

Full Changelog: v1.4.7...v.1.4.71

v.1.4.7

Features

• Added storage method for matplotlib figures
• Added GridSearch sampler*
• Added helper functions for datageneration with hydra configuration files
• Added overwrite function to ExperimentData
• Added callback functionality for optimizers
• Allow addition of Domains
• Add differentiable tag to benchmark functions and optimizers
• Added cluster_parallel mode to `ExperimentData.evaluate()

* only working for categorical or discrete variables!

Bugfixes

• Fixes #248
• Fixes #250
• Fixes #252
• Fixes #253
• Fixes #259
• Fixes #89
• Fixes #230
• Fixes #223
• Fixes #218

What's Changed

• Fixes #248 by @mpvanderschelling in #249
• Mpvanderschelling/issue250 by @mpvanderschelling in #255
• Improving usability by implementing helper function to convert arbitrary functions to DataGenerators by @mpvanderschelling in #254
• Documentation is both hosted by GitHub Pages and ReadTheDocs by @mpvanderschelling in #256
• Implement new x0_selection strategy and add select_all_finished functionality by @mpvanderschelling in #260
• RETRY: refactoring optimization iterate and iterate_scipy by @mpvanderschelling in #262
• Pr/1.4.7 by @mpvanderschelling in #263

Full Changelog: v1.4.6...v1.4.7

v1.4.6

Major changes

• Added documentation on SLURM job scheduler. Added sphinx-tabs as dependency when building documentation.
• WIP: New back-end of _Data that relies on lists instead of pd.DataFrame. This has not yet replaced the pandas back-end but tests are passing with the new _newdata.py module.
• Removed unused method Domain.from_yaml.
• Removed unused _Data.fill_output method
• Output of benchmark functions is now a float instead of np.ndarray[float]. Necessary to pass tests for new back-end, won't affect pandas back-end.

Minor changes

• Refactoring parts of the ExperimentSample code to be more robust to changes in the back-end
• Moving factory methods to appropriate modules
• Removed try_import; import checks are moved to extension packages
• Added __version__.py file
• Updated docstrings to remove leading spaces

Bugfixes

• Correct equality operator of Domain to also compare for output_space attribute
• Closes #241
• Closes #191
• Closes #240
• Closes #243

What's Changed

• Newdata by @mpvanderschelling in #245
• Pr/1.4.6 by @mpvanderschelling in #246

Full Changelog: v1.4.5...v1.4.6

v1.4.5

This pull request will update the main code to version 1.4.5

Major updates

Domain and Parameter classes

• All Parameter classes are now private. The suggested way to add parameters to a Domain will be with the public add_float, add_int, add_category and add_constant methods.
• Change the behaviour of the public Domain.add method to require the type and arguments of the (private) parameter to construct, instead of requiring the private Parameter object

ExperimentData class

• Added a method that extracts all ExperimentSample objects or a selection of ExperimentSample objects from an ExperimentData object
• Removed the .filename attribute in ExperimentData: the name of the stored objects are hardcoded
• Refactored the .path attribute to the .project_dir attribute. When storing the ExperimentData object with the .store() method, a subdirectory (/experiment_data/) will be created and the input data, output data, domain and jobs will be stored there.

Optimizer class

• Added functionality to select different strategies to determine the initial points ($x_0$) before optimization.

_Data class

• Decoupled the headers of the _Data class to a separate private _Columns class. This makes it more flexible for future development on the generalization of different back-ends (currently pandas) for _Data
• Removed dependency of Domain to _Data class

Storing output data

• Output that is stored to disk will no longer have the path_ prefix before the parameter. This information is stored within the _Columns object
• The ExperimentSample.output_data will, if applicable, load the output parameters from disk automatically
• The attribute ExperimentSample.output_data_with_references will give you the paths of the references
• Added backwards compatibility for ExperimentSample.output_data_loaded (will redirect to ExperimentSample.output_data

Documentation

• Made private methods of public objects visible in sphinx documentation API

Bessa Group Coding Guidelines

• Restored the original .flake8 file of the BRG coding guidelines; the maximum linewidth is now 79 instead of 119.

Miscellaneous

• Represent all private attributes and methods with an underscore (_).

Closed issues

• #224
• #206
• #225
• #227
• #61
• #62
• #73
• #129
• #202

Full Changelog: v1.4.4...v1.4.5

v1.4.4

Bugfixes and enhancement featured by @BernardoFerreira

What's Changed

• Make DataGenerator.run method private by @mpvanderschelling in #197
• Change the default behaviour of the logger so that it doesn't display messages by @mpvanderschelling in #196
• Mpvanderschelling/issue189 by @mpvanderschelling in #199
• ExperimentData.store documentation is not correct by @mpvanderschelling in #203
• Handle similar bounds on add_float to make a constant parameter by @mpvanderschelling in #198
• Get a way to extract input and output data from ExperimentData by @mpvanderschelling in #200
• Fixes #194 by @mpvanderschelling in #204
• Pr/1.4.4 by @mpvanderschelling in #210

Important Note: this release has been recreated to support read-the-docs documentation building.
Now the (static) documentation of this release will be available even when a newer release comes uit

Full Changelog: v1.4.3...v1.4.4