Py-experimenter

===================

Feature
-------

- Added documentation about how to execute PyExperimenter on distributed machines.
- Improved the usage and documentation of ssh tunnel to be more flexible and user friendly.
- Added add_experiment_and_execute method to PyExperimenter to add and execute an experiment in one step.
- Added functionality to attach multiple processes to the same experiment, all being able to write to the database tables of the same experiment.

===================

Feature
-------

- Added logging whenever a sql statement is executed.
- Update CI such that the tests are run on Python 3.9 and 3.10, additionally removed the paper draft action.
- Added logging when initializing database to contain resultfields and logfields.

Fix
---

- Booleans have been added as strings to the database table in SQLite. This has been fixed by adding a converting the values accordingly before writing them to the database.
- Bugfix, where the same experiment has been pulled multiple times when using `n_jobs` > 1.
- Bugfix where the ssh passphrase was not correctly addressed in the documentation, and not been used correctly in the code.
- Fix in the documentation, where logfields were indented incorrectly.

===================

Feature
-------

- Add functionality to pause and later continue experiments.
- Change the supported database configuration file type to YAML.
- Change the supported credentials file type to YAML.
- Add support for ssh jump hosts in the database connection.

Fix
---

- Fix a problem when executing fill_table that caused some entries to occur twice.
- Temporary CodeCarbon files are automatically removed at termination.

===================

Feature
-------

- Add `random_order` parameter to `PyExperimenter.execute()` to allow for random order of experiments.
- Add pause functionality to `PyExperimenter` to allow for pausing the execution of experiments, which can be continued later on.

Fix
---

- Hotfix cluster execution where multiple runners could pull the same experiment.
- Update logger documentation to reflect the changes of the improved logging.

===================

Feature
-------

- Removed the need for resultfields to be defined in the experiment configuration file. Therefore, they are now optional, which might help if one is only interested in the information from logtables.
- Improved error messages to provide better feedback about why a configuration file is not valid and why processing information to the database did not work.
- Logging has been implemented for `PyExperimenter`. The name, log level and log file of the logger can be customized. Furthermore, a fixed formatter has been added, as well as different (file) handlers to ensure the messages occur both in the console as well as in the (given) log file.

Examples
--------

- Updated example notebooks to reflect the changes of the improved logging.

Fix
---

- `PyExperimenter` no longer overwrites the basicConfig of the logging framework.

===================

Feature
-------

- Added ``CodeCarbon`` to automatically measure carbon emissions of experiments.
- Improved issue template.
- Added template for pull requests.
- Extended documentation for development / how to contribute to ``PyExperimenter``


Examples
--------

- Updated examples to utilize ``CodeCarbon`` functionality.

Changed
-------

- Replaced ``mysql-connector-python`` dependency to use ``pymysql`` instead.

Fix
---

- Bugfix escaping of values in sql statements.