added readme and cleanup files

.github/workflows/hugging-face.yaml

@@ -16,14 +16,15 @@ jobs:
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "GitHub Actions"
+
       - name: Update README.md
         run: |
           tmp_file=$(mktemp)
           echo "---" >> $tmp_file
           echo "title: Ve Gans" >> $tmp_file
-          echo "emoji: 📈" >> $tmp_file
+          echo "emoji: 🏠" >> $tmp_file
           echo "colorFrom: yellow" >> $tmp_file
-          echo "colorTo: gray" >> $tmp_file
+          echo "colorTo: indigo" >> $tmp_file
           echo "sdk: streamlit" >> $tmp_file
           echo "sdk_version: 1.29.0" >> $tmp_file
           echo "app_file: space.py" >> $tmp_file

README.md

@@ -1,72 +1,29 @@
-# ve-gans: Image Generation with GANs using PyTorch
+# Ve-gans
 
-## Overview
+Ve-gans is an ongoing research project focused on developing a generative AI model specifically designed to generate floorplans and architectural drawings. The project aims to advance the capabilities of GANs (Generative Adversarial Networks) in the field of architectural design.
 
-ve-gans is a project for image generation using Generative Adversarial Networks (GANs) implemented in PyTorch.
+## Project Highlights
 
-## Features
-
-- GAN model for image generation.
-- Separate scripts for training and generating images.
-- Easy-to-use command-line interface.
-
-## Installation
-
-1. **Clone the repository:**
-
-   ```bash
-   git clone https://github.com/zaibutcooler/ve-gans.git
-   cd ve-gans
-   ```
+The highlight of this project is the [research paper](https://docs.google.com/document/d/1nm6Pj3HaDo-W2HAQPPrgGqWIH74SPgQZAHxC5Uk20PQ/edit?usp=sharing) that is being written, detailing the methodologies, experiments, and findings related to the generation of architectural designs using GANs.
 
-2. **Install dependencies:**
+## Features
 
-   ```bash
-   pip install -r requirements.txt
-   ```
+- **Generative AI for Architecture**: Specially designed to generate floorplans and architectural drawings.
+- **Advanced GAN Techniques**: Utilizes cutting-edge GAN methodologies to create detailed and realistic architectural designs.
+- **Research-Driven**: The development process is guided by rigorous research and experimentation.
 
 ## Usage
 
-### Training
-
-To train the GAN model, use the following command:
-
-  ```bash
-  ve-gans-train
-  ```
-
-## Generating Images
+To use the Ve-gans model and explore its capabilities, refer to the [source code](https://github.com/zaibutcooler/ve-gans) and other resources provided below.
 
-To generate images with the trained model, use the following command:
+## Links
 
-  ```bash
-  ve-gans-generate
-  ```
-
-## Project Structure
-
-- `ve_gans/`: Python package containing GAN implementation and utilities.
-  - `generator.py`: Implementation of the GAN generator.
-  - `discriminator.py`: Implementation of the GAN discriminator.
-  - `utils.py`: Utility functions.
-- `requirements.txt`: List of project dependencies.
-- `setup.py`: Setup script for installing the package.
-- `main.py`: Example script for using the ve-gans package.
-
-## Contributing
-
-Contributions are welcome! Please follow the [Contribution Guidelines](CONTRIBUTING.md).
+- [Source Code](https://github.com/zaibutcooler/ve-gans)
+- [Research Paper](https://docs.google.com/document/d/1nm6Pj3HaDo-W2HAQPPrgGqWIH74SPgQZAHxC5Uk20PQ/edit?usp=sharing)
+- [Hugging Face Space](https://huggingface.co/spaces/zaibutcooler/ve-gans)
+- [Opensourced Model](https://huggingface.com/zaibutcooler/ve-gans)
+- [Dataset](https://huggingface.co/datasets/zaibutcooler/archi-12k)
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Acknowledgments
-
-Mention any contributors or libraries that you used or were inspired by.
-
-## Contact
-
-- Zai
-- <[email protected]>
-- Project Link: [https://github.com/zaibutcooler/ve-gans](https://github.com/zaibutcooler/ve-gans)
+This project is licensed under the GNU GENERAL PUBLIC LICENSE. See the [LICENSE](LICENSE) file for details.

setup.py

@@ -1,21 +0,0 @@
-from setuptools import setup, find_packages
-
-with open("requirements.txt") as f:
-    requirements = f.read().splitlines()
-
-setup(
-    name="ve-gans",
-    version="0.1",
-    packages=find_packages(),
-    install_requires=requirements,
-    author="Zai",
-    author_email="[email protected]",
-    description="Floorplan generation model with pytorch",
-    long_description="Detailed description of your project",
-    url="https://github.com/zaibutcooler/ve-gans",
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-)

todo.txt

@@ -1 +0,0 @@
-TODO need to start working on comments

vegans/dataset.py

@@ -33,4 +33,4 @@ class TrainData(Dataset):
         return image, label
 
     def __len__(self):
-        return len(self.images)
+        return len(self.images)

version.py

@@ -1 +0,0 @@
-__version__ = "20231117"