Merge pull request #41 from praksharma/development

Vector UML diagrams uploaded
praksharma · Feb 1, 2024 · 6fdc3c5 · 6fdc3c5
2 parents 82f14ae + 738c547
commit 6fdc3c5
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -84,4 +84,12 @@ 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
+cd UML\ diagrams
+pyreverse -o pdf ../DeepINN/
 ```
diff --git a/UML diagrams/classes.pdf b/UML diagrams/classes.pdf
diff --git a/UML diagrams/packages.pdf b/UML diagrams/packages.pdf
diff --git a/todo.md b/todo.md
@@ -15,9 +15,9 @@ Last work : `DeepINN/constraint/gradients.py`
 ## Constraints
 - [X] Implement the prescribed BC part in constraint/ boundary_loss dirichletBC.
 - [X] Implement PDE loss constraint.
-- [ ] Implement gradients.
+- [x] Implement gradients.
 - [ ] Implement lazy evaluation of gradients.
-- [ ] Implement more constrainst.
+- [ ] Implement more constraint.
 
 ## Architectures
 - [x] Implement fully connected NN.
@@ -27,7 +27,7 @@ Last work : `DeepINN/constraint/gradients.py`
 - [x] Basic geometry tutorials.
 - [x] Constraints tutorials.
 - [ ] Add template PDE in constraint directory.
-- [ ] There is some problem with FCNN tutorial. probably the feature scaling isn't working.
+- [x] There was some problem with FCNN tutorial. It was incorrect PDE.
 
 ## Misc
 - [x] Migrate to JupyterBooks.