add readme

CS123n · May 29, 2022 · a082040 · a082040
1 parent b9947a5
commit a082040
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 90 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 *.pyc
+test
diff --git a/input/func.py b/input/func.py
@@ -1,7 +1,8 @@
 import torch as th
 
 def origin_func(x, y):
-    return - 2 * th.exp(x + y) #* (th.sin(x) * th.sin(y) - th.cos(x) * th.cos(y))
+    # return - 2 * th.exp(x + y) * (th.cos(x) * th.cos(y) - th.sin(x) * th.sin(y))
+    return - 2 * th.exp(x + y) * th.cos(x + y)
 
 def target_func(x, y):
-    return th.exp(x + y) #* th.cos(x) * th.sin(y)
+    return th.exp(x + y) * th.cos(x) * th.sin(y)
diff --git a/main.py b/main.py
@@ -42,6 +42,7 @@
     if rank == 0:
         print(u.view(w, w)[:8, :8])
 
+
     # if rank == 3:
     #     print(u.view(w, w)[0:8, 0:8])
 

diff --git a/readme.md b/readme.md
@@ -0,0 +1,18 @@
+# MultiGrid Method
+
+Hi, everyone! This repo provides a parallel version of 2-D multigrid method based on Pytorch.
+
+Install necessary python packages:
+```bash
+pip install -r requirements.txt
+```
+
+Run single node version:
+```bash
+python main.py -n 64 -p 1
+```
+
+Run multi-node version:
+```bash
+torchrun --nproc_per_node 4 main.py -n 64 -p 2
+```
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+torch>=1.10.0
diff --git a/test/smooth.py b/test/smooth.py
diff --git a/test/test.py b/test/test.py
diff --git a/test/test1.py b/test/test1.py