Skip to content

Commit 67725ed

Browse files
authored
Merge pull request #21 from intsystems/petr-parker-patch-1
Update README.md
2 parents 40c4b6f + a541d09 commit 67725ed

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
# Implicit Reparametrization Trick
1+
<div align="center">
2+
<h1> Implicit Reparametrization Trick </h1>
3+
</div>
24

35
<div align="center">
46
<img src="images/implicit.webp" width="500px" />
57
</div>
68

9+
<p align="center">
10+
<a href="https://github.com/intsystems/discrete-variables-relaxation/tree/main/tests">
11+
<img alt="Coverage_2" src="https://github.com/intsystems/implicit-reparameterization-trick/actions/workflows/testing.yml/badge.svg" />
12+
</a>
13+
<a href="https://intsystems.github.io/discrete-variables-relaxation">
14+
<img alt="Docs" src="https://github.com/intsystems/implicit-reparameterization-trick/actions/workflows/docs.yml/badge.svg" />
15+
</a>
16+
</p>
717

818
<table>
919
<tr>
@@ -20,16 +30,11 @@
2030
</tr>
2131
</table>
2232

23-
24-
![Testing](https://github.com/intsystems/implicit-reparameterization-trick/actions/workflows/testing.yml/badge.svg)
25-
![Docs](https://github.com/intsystems/implicit-reparameterization-trick/actions/workflows/docs.yml/badge.svg)
26-
27-
28-
## Description
33+
## 💡 Description
2934

3035
This repository implements an educational project for the Bayesian Multimodeling course. It implements algorithms for sampling from various distributions, using the implicit reparameterization trick.
3136

32-
## Scope
37+
## 🗃 Scope
3338
We plan to implement the following distributions in our library:
3439
- [x] Gaussian normal distribution (*)
3540
- [x] Dirichlet distribution (Beta distributions)(\*)
@@ -44,11 +49,11 @@ We plan to implement the following distributions in our library:
4449

4550
(\*\*\*) - this distribution is not very clear in implementation, its inclusion is questionable
4651

47-
## Stack
52+
## 📚 Stack
4853

4954
We plan to inherit from the torch.distribution.Distribution class, so we need to implement all the methods that are present in that class.
5055

51-
## Usage
56+
## 👨‍💻 Usage
5257
In this example, we demonstrate the application of our library using a Variational Autoencoder (VAE) model, where the latent layer is modified by a normal distribution.
5358
```
5459
>>> import torch.distributions.implicit as irt
@@ -66,7 +71,7 @@ In this example, we demonstrate the use of a mixture of distributions using our
6671
>>> outputs = Decoder(deviated)
6772
```
6873

69-
## Links
74+
## 📬 Links
7075
- [LinkReview](https://github.com/intsystems/implitic-reparametrization-trick/blob/main/linkreview.md)
7176
- [Plan of project](https://github.com/intsystems/implitic-reparametrization-trick/blob/main/planning.md)
7277
- [BlogPost](blogpost/Blog_post_sketch.pdf)

0 commit comments

Comments
 (0)