Initial README

README.md

@@ -1,3 +1,31 @@
----
-license: mit
----
+---
+license: mit
+---
+
+explain a high-level overview of your code and how to run your code: 
+including what packages I must install, and 
+where the data came from and in which folder it must go.
+
+
+# Face Recognition Model
+
+
+## Files
+
+## Neccessary Package
+  - Since the model all runs on Hugging Face, you don't need to install any packages.
+  - However, if you do want to run the model locally, you will need to install these following packages:
+    ``import torch
+      import torch.nn as nn
+      import torch.optim as optim
+      import torch.nn.functional as F
+      import numpy as np
+      import torchvision
+      from torchvision import *
+      from torch.utils.data import Dataset, DataLoader``
+
+## Running
+  - You can run this model using the Hugging Face Space: CSSE416-final-project/faceRecogModel
+    - You can upload images through the Space UI.
+  - Alternatively, if you want to run the model locally, you can use <<this>> file to load the weights.
+