add table of contents and docs

CONTRIBUTING.md

@@ -1,6 +1,32 @@
+
+
 # 1. Contributing
 
 We welcome everyone to contribute to Solo-Synth-GAN. This document is to help you on setting up your environment, finding a task, and opening pull requests.
+- [1. Contributing](#1-contributing)
+  - [1.1 Development setup](#11-development-setup)
+- [2. Contributing to Solo-Synth-GAN](#2-contributing-to-solo-synth-gan)
+  - [2.1 Code of Conduct](#21-code-of-conduct)
+- [3. Project Organization](#3-project-organization)
+- [4.  Issues](#4--issues)
+- [5. Pull Requests](#5-pull-requests)
+- [6. Style Guides](#6-style-guides)
+  - [6.1 Code Style Guide](#61-code-style-guide)
+- [7. Documentation Style Guide](#7-documentation-style-guide)
+- [8. Headers](#8-headers)
+  - [8.2 Links](#82-links)
+  - [8.3 Changelog](#83-changelog)
+  - [8.4 Commit Message Style Guide](#84-commit-message-style-guide)
+- [9. Development Environment](#9-development-environment)
+- [10. Versions](#10-versions)
+  - [10.1 Version Status](#101-version-status)
+  - [10.2 Version Workflow](#102-version-workflow)
+- [11. Release Process](#11-release-process)
+- [12. Issue and Pull Request Labels](#12-issue-and-pull-request-labels)
+  - [12.1 Type of Issue or Pull Request](#121-type-of-issue-or-pull-request)
+  - [12.2 Category of Issue or Pull Request](#122-category-of-issue-or-pull-request)
+  - [12.3 Status of Issue](#123-status-of-issue)
+  - [12.4 Status of Pull Request](#124-status-of-pull-request)
 
 ## 1.1 Development setup
 
@@ -487,4 +513,3 @@ label from the same group.
 [PEP 440]: https://www.python.org/dev/peps/pep-0440/
 [PyPI]: https://pypi.org/project/Markdown/
 [Solo-Synth-GAN/Solo-Synth-GAN.github.io]: https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0.github.io
-

README.md

@@ -10,15 +10,33 @@
 ![Pyramid](Images/pyramid.jpg)
 
 
-
-
 # Solo-Synth GAN: Train only on one image
 
 ![lightning_animation](Images/balloons.png) | ![lightning_animation](Results/start_scale=0_alpha=0.1_beta=0.95.gif)
 
 This is the open-source repository for the project Solo-Synth GAN which is one of the latest zero shot generative adversarial network techniques for image-2-video while training it only on a <b><i>SINGLE IMAGE</i></b>
 For a concise summary of our research, please refer to our [paper](https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0). (Will be updated once paper is published)
 
+# Table of Contents
+- [Solo-Synth-GAN (Zero Shot Image-2-Video)](#solo-synth-gan-zero-shot-image-2-video)
+- [Solo-Synth GAN: Train only on one image](#solo-synth-gan-train-only-on-one-image)
+- [Table of Contents](#table-of-contents)
+- [1. Overview](#1-overview)
+- [2. Repo Structure](#2-repo-structure)
+- [3. Model Architecture](#3-model-architecture)
+  - [3.1 Model Architecture GPU (Nvidia, TPU, A100, V100, NcASV3/6)](#31-model-architecture-gpu-nvidia-tpu-a100-v100-ncasv36)
+  - [3.2 Unconditional Generation (GPU is a must and required for training and generation)](#32-unconditional-generation-gpu-is-a-must-and-required-for-training-and-generation)
+  - [3.3 Customization Options](#33-customization-options)
+  - [3.4 Unconditional Generation (Arbitrary Sizes)](#34-unconditional-generation-arbitrary-sizes)
+- [4 Image-2-Video Zero Shot](#4-image-2-video-zero-shot)
+- [5 Parameter Tuning with examples](#5-parameter-tuning-with-examples)
+  - [5.1 Parameter Descriptions](#51-parameter-descriptions)
+- [6 Tested Environments](#6-tested-environments)
+- [7 Contributing to Solo-Synth-GAN](#7-contributing-to-solo-synth-gan)
+- [8 Additional Data(Coming Soon!)](#8-additional-datacoming-soon)
+- [9 Acknowledgements](#9-acknowledgements)
+
+
 # 1. Overview
 
 In this work, we propose and examine new technique for training Generative Adversarial Networks (GANs) on a single image and generating a video from just a single image. <b>The GAN is not trained on ANY OTHER IMAGE.</b>