Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update and include example notebooks #45

Merged
merged 3 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Currently, five approaches are implemented, including their original hyperparame
* **TBiGRU** by Cao et al. (2021)
* **Consistency-DANN** by Siahpour et al. (2022)

Three approaches are implemented without their original hyperparameters:

* **ConditionalDANN** by Cheng et al. (2021)
* **ConditionalMMD** by Cheng et al. (2021)
* **PseudoLabels** as used by Wang et al. (2022)

This includes the following general approaches adapted for RUL estimation:

* **Domain Adaption Neural Networks (DANN)** by Ganin et al. (2016)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Examples

* [ADARUL](adarul.ipynb)
* [LSTM-DANN](lstm_dann.ipynb)
* [CNN-DANN](cnn_dann.ipynb)
* [Conditional Approaches](conditional.ipynb)
* [Consistency-DANN](consistency_dann.ipynb)
* [LatentAlign](latent_align.ipynb)
* [Psuedo Labels](pseudo_labels.ipynb)
* [TBiGRU](tbigru.ipynb)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,18 @@ Currently, five approaches are implemented, including their original hyperparame
* **[TBiGRU][rul_adapt.approach.tbigru]** by Cao et al. (2021)
* **[Consistency-DANN][rul_adapt.approach.consistency]** by Siahpour et al. (2022)

Three approaches are implemented without their original hyperparameters:

* **[ConditionalDANN][rul_adapt.approach.conditional]** by Cheng et al. (2021)
* **[ConditionalMMD][rul_adapt.approach.conditional]** by Cheng et al. (2021)
* **[PseudoLabels][rul_adapt.approach.pseudo_labels]** as used by Wang et al. (2022)

This includes the following general approaches adapted for RUL estimation:

* **Domain Adaption Neural Networks (DANN)** by Ganin et al. (2016)
* **Multi-Kernel Maximum Mean Discrepancy (MMD)** by Long et al. (2015)

Each approach has an example notebook which can be found in the [examples](https://github.com/tilman151/rul-adapt/tree/master/examples) folder.
Each approach has an example notebook which can be found in the [examples](examples) folder.

## Installation

Expand Down
11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ theme:
nav:
- Introduction: index.md
- API Reference: api/
- Examples:
- AdaRUL: examples/adarul.ipynb
- LSTM-DANN: examples/lstm_dann.ipynb
- CNN-DANN: examples/cnn_dann.ipynb
- Conditional: examples/conditional.ipynb
- Consistency: examples/consistency_dann.ipynb
- LatentAlign: examples/latent_align.ipynb
- PseudoLabels: examples/pseudo_labels.ipynb
- TBiGRU: examples/tbigru.ipynb

markdown_extensions:
- attr_list
Expand All @@ -42,6 +51,8 @@ plugins:
- search
- autorefs
- section-index
- mkdocs-jupyter:
no_input: False
- gen-files:
scripts: [docs/gen_ref_pages.py]
- literate-nav:
Expand Down
Loading