StoryGenerator / README.md
Faizan Azizahmed Shaikh
Update README.md
b96c858
|
raw
history blame
2.56 kB
---
title: StoryGenerator
emoji: πŸ’»
colorFrom: blue
colorTo: gray
sdk: gradio
sdk_version: 3.39.0
app_file: app.py
pinned: false
license: apache-2.0
---
# Story Generator πŸ“–βœ¨
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!
![App Interface](interface_screenshot.png) *// Replace with actual screenshot of your application.*
## Table of Contents πŸ“‘
1. [About The Project](#about-the-project-πŸ“–)
2. [Getting Started](#getting-started-πŸš€)
3. [Usage](#usage-🎈)
4. [License](#license-πŸ“„)
5. [Contact](#contact-πŸ“ž)
6. [Acknowledgements](#acknowledgements-πŸ™)
## About The Project πŸ“–
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.
The user interface for the application is created using Gradio.io, a Python library for quickly creating customizable UI components around Python functions.
## Getting Started πŸš€
To get a local copy up and running, follow these simple steps:
1. Make sure you have git-lfs installed (https://git-lfs.com)
```sh
git lfs install
```
2. Clone the repo
```sh
git clone [email protected]:spaces/paschar/EroticStoryGenerator
```
3. Install the required Python libraries
```sh
pip3 install transformers gradio
```
4. Run the application
```sh
python app.py
```
## Usage 🎈
Using the Erotic Story Generator is as simple as 1, 2, 3!
1. Enter a story prompt in the text box.
2. Specify the model to be used (default is "coffeeee/nsfw-story-generator2").
3. Set the length of the story using the slider.
4. Click the "Entertain" button to generate your story!
## License πŸ“„
Distributed under the apache-2.0 License. See `LICENSE` for more information.
## Contact πŸ“ž
Faizan Shaikh - [@mr-shaikh25](https://github.com/mr-shaikh25) - [[email protected]]([email protected])
Project Link: [Story Generator Space](https://huggingface.co/spaces/paschar/EroticStoryGenerator)
## Acknowledgements πŸ™
- [HuggingFace Transformers](https://huggingface.co/transformers/)
- [Gradio](https://www.gradio.app/)
---
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
---