Faizan Azizahmed Shaikh commited on
Commit
4050edd
Β·
1 Parent(s): 8b64fce

Updates Readme.md

Browse files
Files changed (1) hide show
  1. README.md +74 -3
README.md CHANGED
@@ -1,8 +1,8 @@
1
  ---
2
- title: EroticStoryGenerator
3
  emoji: πŸ’»
4
- colorFrom: red
5
- colorTo: yellow
6
  sdk: gradio
7
  sdk_version: 3.39.0
8
  app_file: app.py
@@ -10,4 +10,75 @@ pinned: false
10
  license: apache-2.0
11
  ---
12
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
1
  ---
2
+ title: StoryGenerator
3
  emoji: πŸ’»
4
+ colorFrom: blue
5
+ colorTo: gray
6
  sdk: gradio
7
  sdk_version: 3.39.0
8
  app_file: app.py
 
10
  license: apache-2.0
11
  ---
12
 
13
+ # Interactive Story Generator πŸ“–βœ¨
14
+
15
+ Welcome to the Interactive Story Generator, a delightful blend of the HuggingFace Transformers library and Gradio.io's user-friendly interface. This application lets you generate creative stories based on a prompt you provide. So, let your imagination run wild and dive into the world of storytelling!
16
+
17
+ ![App Interface](interface_screenshot.png) *// Replace with actual screenshot of your application.*
18
+
19
+ ## Table of Contents πŸ“‘
20
+
21
+ 1. [About The Project](#about-the-project)
22
+ 2. [Getting Started](#getting-started)
23
+ 3. [Usage](#usage)
24
+ 4. [Contributing](#contributing)
25
+ 5. [License](#license)
26
+ 6. [Contact](#contact)
27
+ 7. [Acknowledgements](#acknowledgements)
28
+
29
+ ## About The Project πŸ“–
30
+
31
+ The Interactive Story Generator is a Python application that uses a language model from the HuggingFace Transformers library to generate stories based on a user-provided prompt. The application also allows the user to specify the length of the generated story.
32
+
33
+ The user interface for the application is created using Gradio.io, a Python library for quickly creating customizable UI components around Python functions.
34
+
35
+ ## Getting Started πŸš€
36
+
37
+ To get a local copy up and running, follow these simple steps:
38
+
39
+ 1. Make sure you have git-lfs installed (https://git-lfs.com)
40
+ ```sh
41
+ git lfs install
42
+ ```
43
+ 2. Clone the repo
44
+ ```sh
45
+ git clone [email protected]:spaces/paschar/EroticStoryGenerator
46
+ ```
47
+ 3. Install the required Python libraries
48
+ ```sh
49
+ pip3 install transformers gradio
50
+ ```
51
+ 4. Run the application
52
+ ```sh
53
+ python app.py
54
+ ```
55
+
56
+ ## Usage 🎈
57
+
58
+ Using the Erotic Story Generator is as simple as 1, 2, 3!
59
+
60
+ 1. Enter a story prompt in the text box.
61
+ 2. Specify the model to be used (default is "coffeeee/nsfw-story-generator2").
62
+ 3. Set the length of the story using the slider.
63
+ 4. Click the "Entertain" button to generate your story!
64
+
65
+ ## License πŸ“„
66
+
67
+ Distributed under the apache-2.0 License. See `LICENSE` for more information.
68
+
69
+ ## Contact πŸ“ž
70
+
71
+ Faizan Shaikh - [@mr-shaikh25](https://github.com/mr-shaikh25) - [email protected]
72
+
73
+ Project Link: [https://huggingface.co/spaces/paschar/EroticStoryGenerator]
74
+
75
+ ## Acknowledgements πŸ™
76
+
77
+ - [HuggingFace Transformers](https://huggingface.co/transformers/)
78
+ - [Gradio](https://www.gradio.app/)
79
+
80
+ ---
81
+
82
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
83
+
84
+ ---