pain commited on
Commit
451c98a
·
verified ·
1 Parent(s): b0359f9

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -51
README.md DELETED
@@ -1,51 +0,0 @@
1
- # Gradio Application
2
-
3
- <img src="image_logo.png" style="width:50%; height:auto;">
4
-
5
-
6
- This is a Gradio application that allows you to generate an Arabic story using generative AI models.
7
-
8
- ## Installation
9
-
10
- 1. Clone this repository:
11
-
12
- ```shell
13
- git clone https://github.com/mohammad-albarham/Arabic_story_generator.git
14
- ```
15
-
16
- 2. Install the required dependencies:
17
-
18
- ```shell
19
- pip install -r requirements.txt
20
- ```
21
-
22
- ## Usage
23
-
24
- 0. Add the keys for OPEN AI API model and stability AI API in [models.py](https://github.com/mohammad-albarham/Arabic_story_generator/blob/3702d6cad85fe38ff5944d7f99f43a37d7dec151/llm_models.py#L16) and [image_generator.py](https://github.com/mohammad-albarham/Arabic_story_generator/blob/3702d6cad85fe38ff5944d7f99f43a37d7dec151/image_generator.py#L22)
25
- 1. Run the application:
26
-
27
- ```shell
28
- gradio app.py
29
- ```
30
-
31
- 2. Open your web browser and navigate to [http://localhost:7860](http://localhost:7860).
32
-
33
- 3. Add your a description and the needed number of pages and click on generate story.
34
-
35
- ## Contributing
36
-
37
- Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
38
-
39
- ### Instrcutions for the contribution:
40
-
41
- 1. Please install black formatter as follows:
42
- `pip install black`
43
- 2. Make sure to format all python files you want to change using this command on the terminal:
44
- `black .`
45
-
46
- You can see this tutorial for more information about the formatter: [tutorial](https://www.freecodecamp.org/news/auto-format-your-python-code-with-black/)
47
-
48
-
49
- ## License
50
-
51
- [ACADEMIC PUBLIC LICENSE](https://github.com/mohammad-albarham/Arabic_story_generator/tree/main?tab=License-1-ov-file)