Skip to content

Commit

Permalink
Add "How to cite"
Browse files Browse the repository at this point in the history
  • Loading branch information
OverLordGoldDragon committed Jul 7, 2021
1 parent 635b5a0 commit 1128d21
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![Coverage Status](https://coveralls.io/repos/github/OverLordGoldDragon/keras-adamw/badge.svg?branch=master&service=github)](https://coveralls.io/github/OverLordGoldDragon/keras-adamw)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1215c1605ad545cba419ee6e5cc870f5)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=OverLordGoldDragon/keras-adamw&utm_campaign=Badge_Grade)
[![PyPI version](https://badge.fury.io/py/keras-adamw.svg)](https://badge.fury.io/py/keras-adamw)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5080529.svg)](https://doi.org/10.5281/zenodo.5080529)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

![](https://img.shields.io/badge/keras-tensorflow-blue.svg)
Expand Down Expand Up @@ -127,3 +128,21 @@ get_total_iterations(0, num_epochs=[1,3,5,8], iterations_per_epoch=[240,120,60,3
- Best used for pretrained layers - e.g. greedy layer-wise pretraining, or pretraining a feature extractor to a classifier network. Can be a better alternative to freezing layer weights. --_My recommendation_
- It's often best not to pretrain layers fully (till convergence, or even best obtainable validation score) - as it may inhibit their ability to adapt to newly-added layers. --_My recommendation_
- The more the layers are pretrained, the lower their fraction of new layers' `lr` should be. --_My recommendation_

## How to cite

Short form:

> OverLordGoldDragon, keras-adamw, 2019. GitHub repository, https://github.com/OverLordGoldDragon/keras-adamw/. DOI: 10.5281/zenodo.5080529
BibTeX:

```bibtex
@article{OverLordGoldDragon2019keras-adamw,
title={Keras AdamW},
author={OverLordGoldDragon},
journal={GitHub. Note: https://github.com/OverLordGoldDragon/keras-adamw/},
year={2019},
doi={10.5281/zenodo.5080529},
}
```

0 comments on commit 1128d21

Please sign in to comment.