Skip to content

Commit

Permalink
Merge pull request #67 from aced-differentiate/add_changelog
Browse files Browse the repository at this point in the history
Add changelog to docs
  • Loading branch information
rkurchin authored Mar 24, 2021
2 parents 43e0b67 + 9fdf028 commit 344e265
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ makedocs(
"Example 2" => "examples/example_2.md"],
"Functions" => Any[
"Layers" => "functions/layers.md",
"Models" => "functions/models.md"]
"Models" => "functions/models.md"],
"Changelog" => "changelog.md"
],
format = Documenter.HTML(
# Use clean URLs, unless built as a "local" build
Expand Down
29 changes: 29 additions & 0 deletions docs/src/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Changelog

I'm generally trying to adhere to [semver](https://semver.org) here. This means that in v0.*, assume breaking changes are always possible, even without a major version bump...however, I will try to always note them here if they happen...

Categories to include for each release, if relevant: breaking, added, fixed, removed/deprecated

## v0.1.2 [2021-03-22]

### Added:
* CGCNN model builder defaults to half `atom_conv_fea_len` for `pooled_fea_len` parameter
* docs: add documentation website!
* docs: remove conda environment files from example 1 and just include instructions to set up an environment from scratch for downloading data

### Fixed:
* import loss functions via `Flux.Losses` to be compatible with upcoming Flux v0.12
* change syntax of `build_graphs_batch` in example 2 to match changes to ChemistryFeaturization
* rename `master` branch to `main`

## v0.1.1 [2021-03-11]
### Fixed:
* explicitly import `Flux.glorot_uniform`, which is no longer exported by Flux otherwise

## v0.1.0 [2021-02-25]

First released version!

### Added:
* create `AGNConv` and `AGNPool` layers
* create basic CGCNN model builder

0 comments on commit 344e265

Please sign in to comment.