Skip to content

Commit

Permalink
Add changelog (#28)
Browse files Browse the repository at this point in the history
Add changelog of develops so far including those since last tagged commit (`v0.1.0`)
  • Loading branch information
leifdenby authored May 15, 2024
1 parent b0050b9 commit 83d50bf
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Changelog

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

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [unreleased](https://github.com/joeloskarsson/neural-lam/compare/v0.1.0...HEAD)

### Added

- new metrics (`nll` and `crps_gauss`) and `metrics` submodule, stddiv output option
[c14b6b4](https://github.com/joeloskarsson/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
@joeloskarsson

- ability to "watch" metrics and log
[c14b6b4](https://github.com/joeloskarsson/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
@joeloskarsson

- pre-commit setup for linting and formatting
[\#6](https://github.com/joeloskarsson/neural-lam/pull/6), [\#8](https://github.com/joeloskarsson/neural-lam/pull/8)
@sadamov, @joeloskarsson

### Changed

- moved batch-static features ("water cover") into forcing component return by `WeatherDataset`
[\#13](https://github.com/joeloskarsson/neural-lam/pull/13)
@joeloskarsson

- change validation metric from `mae` to `rmse`
[c14b6b4](https://github.com/joeloskarsson/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
@joeloskarsson

- change RMSE definition to compute sqrt after all averaging
[\#10](https://github.com/joeloskarsson/neural-lam/pull/10)
@joeloskarsson

### Removed

- `WeatherDataset(torch.Dataset)` no longer returns "batch-static" component of
training item (only `prev_state`, `target_state` and `forcing`), the batch static features are
instead included in forcing
[\#13](https://github.com/joeloskarsson/neural-lam/pull/13)
@joeloskarsson


## [v0.1.0](https://github.com/joeloskarsson/neural-lam/releases/tag/v0.1.0)

First tagged release of `neural-lam`, matching Oskarsson et al 2023 publication
(https://arxiv.org/abs/2309.17370)

0 comments on commit 83d50bf

Please sign in to comment.