Set up README structure

README.md

@@ -1,3 +1,63 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+library_name: pytorch
+pipeline_tag: image-to-image
+datasets:
+- ylecun/mnist
+language:
+- en
+---
+
+# DenseUNet
+
+An image-to-image model for upscaling blurry MNIST-like images.
+
+## Table of contents
+- [Model Summary](#model-summary)
+- [Use Cases & Limitations](#use-cases--limitations)
+- [How to Use](#how-to-use)
+- [Model Details](#model-details)
+- [Training Procedure](#training-procedure)
+- [Evaluation](#evaluation)
+- [Ethical Considerations & Limitations](#ethical-considerations--limitations)
+- [Caveats and Recommendations](#caveats-and-recommendations)
+- [Citation](#citation)
+- [License](#license)
+- [Contact](#contact)
+
+---
+
+## Model Summary
+- **Task:** Image to image (upscaling)
+- **Architecture:** UNet with Dense layers
+- **Inputs:** MNIST image
+- **Outputs:** Upscaled images of numbers
+- **Intended Users:** Students learning image-to-image tasks
+
+## Use Cases & Limitations
+### Intended uses
+- learning image-to-image model behavior
+
+### Out-of-scope uses / limitations
+- Not for production or deployment
+
+## How to Use
+```python
+# ToDo
+```
+
+## Model Details
+
+## Training Procedure
+
+## Evaluation
+
+## Ethical Considerations & Limitations
+
+## Caveats and Recommendations
+
+## Citation
+
+## License
+
+## Contact