UML diagrams

praksharma · Feb 1, 2024 · e53ea37 · e53ea37
1 parent 9e237a4
commit e53ea37
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -84,4 +84,11 @@ prakhars962/deepinn   <none>        fe16ca34f9d9   About an hour ago   6.8GB
 The only solution is to delete them one by one using the IMAGE_ID.
 ```sh
 docker image rm -f IMAGE_ID
+```
+
+### UML diagram
+The UML diagram is generated using `pyreverse`. This provides an overview of the codebase.
+
+```sh
+pyreverse -o png DeepINN/
 ```
diff --git a/classes.png b/classes.png
diff --git a/packages.png b/packages.png
diff --git a/todo.md b/todo.md
@@ -17,7 +17,7 @@ Last work : `DeepINN/constraint/gradients.py`
 - [X] Implement PDE loss constraint.
 - [x] Implement gradients.
 - [ ] Implement lazy evaluation of gradients.
-- [ ] Implement more constrainst.
+- [ ] Implement more constraint.
 
 ## Architectures
 - [x] Implement fully connected NN.