Update readme

.gitattributes

@@ -1,31 +0,0 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -10,4 +10,56 @@ pinned: false
 license: openrail
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Text Autocomplete using HuggingFace
+
+Text Autocomplete, or text generation, is a task in which an application can fill in incomplete text or paraphrase.
+
+## Goal
+
+In this project we are buidling text-autocomplete **streamlit** web-app powered by GPT-neo. GPT-Neo 125M is a transformer model designed using EleutherAI's replication of the GPT-3 architecture. GPT-Neo refers to the class of models, while 125M represents the number of parameters of this particular pre-trained model
+
+## Deployed app
+
+The app is deployed on Huggingface **Spaces**: [Click here for live demo](https://huggingface.co/spaces/SudhanshuBlaze/text-generation-gpt-neo)
+
+### Project Structure
+
+```bash
+Text Generator Project
+
+├── app.py
+└── requirements.txt
+```
+
+### Project Requirements
+
+- Python3
+- git
+
+### Project Steps
+
+- `Step 1`: Cloning the repo
+
+```bash
+git clone https://github.com/DigitalProductschool/AI-Makerspace.git
+```
+
+- `Step 2`: Changing working directory to HuggingFace/Spaces
+
+```bash
+cd AI-Makerspace/HuggingFace/Spaces
+```
+
+- `Step 3`: Installing dependencies using pip3
+
+```bash
+pip3 install -r requirements.txt
+```
+
+- `Step 4`: Running the streamlit web app
+
+```bash
+streamlit run app.py
+```
+
+#### Now go to http://localhost:8501/ to test out this streamlit web-app

app.py

@@ -2,7 +2,7 @@ import streamlit as st
 from transformers import pipeline
 
 st.title("AI text-gen Web-app")
-st.write("This is auto-complete/text generation a web-app powered by GPT-neo. GPT-Neo 125M is a transformer model designed using EleutherAI's replication of the GPT-3 architecture. GPT-Neo refers to the class of models, while 125M represents the number of parameters of this particular pre-trained model.")
+st.write("This is auto-complete/text generation a web-app powered by GPT-neo. Type some text here and this model will generate more.")
 
 # instantiate the model / download
 @st.cache(allow_output_mutation=True)

requirements.txt

@@ -1,2 +1,3 @@
-torch
-transformers
+torch==1.12.0
+transformers==4.19.4
+streamlit==1.13.0