barunsaha commited on
Commit
a30250a
1 Parent(s): 1189403

Update project description to reflect the new conversational interface

Browse files
Files changed (1) hide show
  1. README.md +25 -9
README.md CHANGED
@@ -4,7 +4,7 @@ emoji: 🏢
4
  colorFrom: yellow
5
  colorTo: green
6
  sdk: streamlit
7
- sdk_version: 1.26.0
8
  app_file: app.py
9
  pinned: false
10
  license: mit
@@ -16,34 +16,50 @@ We spend a lot of time on creating the slides and organizing our thoughts for an
16
  With SlideDeck AI, co-create slide decks on any topic with Generative Artificial Intelligence.
17
  Describe your topic and let SlideDeck AI generate a PowerPoint slide deck for you—it's as simple as that!
18
 
19
- SlideDeck AI is powered by [Mistral 7B Instruct](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1).
20
  Originally, it was built using the Llama 2 API provided by Clarifai.
21
 
 
 
 
 
22
  # Process
23
 
24
  SlideDeck AI works in the following way:
25
 
26
- 1. Given a topic description, it uses Mistral 7B Instruct to generate the outline/contents of the slides.
27
  The output is generated as structured JSON data based on a pre-defined schema.
28
  2. Subsequently, it uses the `python-pptx` library to generate the slides,
29
  based on the JSON data from the previous step.
30
- Here, a user can choose from a set of three pre-defined presentation templates.
31
- 3. In addition, it uses Metaphor to fetch Web pages related to the topic.
 
 
 
 
 
 
32
 
33
- 4. ~~Finally, it uses Stable Diffusion 2 to generate an image, based on the title and each slide heading.~~
 
 
 
 
 
 
34
 
35
 
36
  # Local Development
37
 
38
- SlideDeck AI uses [Mistral 7B Instruct](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1)
39
  via the Hugging Face Inference API.
40
- To run this project by yourself, you need to provide the `HUGGINGFACEHUB_API_TOKEN` and `METAPHOR_API_KEY` API keys,
41
  for example, in a `.env` file. Visit the respective websites to obtain the keys.
42
 
43
 
44
  # Live Demo
45
 
46
- [SlideDeck AI](https://huggingface.co/spaces/barunsaha/slide-deck-ai)
47
 
48
 
49
  # Award
 
4
  colorFrom: yellow
5
  colorTo: green
6
  sdk: streamlit
7
+ sdk_version: 1.32.2
8
  app_file: app.py
9
  pinned: false
10
  license: mit
 
16
  With SlideDeck AI, co-create slide decks on any topic with Generative Artificial Intelligence.
17
  Describe your topic and let SlideDeck AI generate a PowerPoint slide deck for you—it's as simple as that!
18
 
19
+ SlideDeck AI is powered by [Mistral 7B Instruct](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2).
20
  Originally, it was built using the Llama 2 API provided by Clarifai.
21
 
22
+ Legacy SlideDeck AI allowed one-shot generation of a slide deck based on the inputs.
23
+ In contrast, SlideDeck AI *Reloaded* enables a conversational interface to create, iterate, and improve your presentation.
24
+
25
+
26
  # Process
27
 
28
  SlideDeck AI works in the following way:
29
 
30
+ 1. Given a topic description, it uses Mistral 7B Instruct to generate the *initial* content of the slides.
31
  The output is generated as structured JSON data based on a pre-defined schema.
32
  2. Subsequently, it uses the `python-pptx` library to generate the slides,
33
  based on the JSON data from the previous step.
34
+ A user can choose from a set of three pre-defined presentation templates.
35
+ 3. At this stage onward, a user can provide additional instructions to refine the content.
36
+ For example, one can ask to add another slide or modify an existing slide.
37
+ 4. Every time SlideDeck AI generates the PowerPoint presentation, a download button is provided.
38
+ Clicking on the button will download the file.
39
+
40
+
41
+ # Known Issues
42
 
43
+ - **Incorrect JSON**: Sometimes the JSON generated could be syntactically incorrect.
44
+ You can try asking SlideDeck AI to regenerate the content and fix the JSON syntax error.
45
+ This, however, is not guaranteed to work. The alternative is to reload the website and try again.
46
+ - **Connection timeout**: Requests sent to the Hugging Face Inference endpoint might time out.
47
+ A maximum of five retries are attempted. If it still does not work, wait for a while and try again.
48
+ - **Cannot paste text in the input box**: If the length of the copied text is greater than the maximum
49
+ number of allowed characters in the textbox, pasting would not work.
50
 
51
 
52
  # Local Development
53
 
54
+ SlideDeck AI uses [Mistral 7B Instruct](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)
55
  via the Hugging Face Inference API.
56
+ To run this project by yourself, you need to provide the `HUGGINGFACEHUB_API_TOKEN` API key,
57
  for example, in a `.env` file. Visit the respective websites to obtain the keys.
58
 
59
 
60
  # Live Demo
61
 
62
+ [SlideDeck AI](https://huggingface.co/spaces/barunsaha/slide-deck-ai) on Hugging Face Spaces
63
 
64
 
65
  # Award