Nick Canu commited on
Commit
0fd0fe9
1 Parent(s): 26b17df

config fix

Browse files
Files changed (1) hide show
  1. README.md +11 -48
README.md CHANGED
@@ -1,48 +1,11 @@
1
- [icon banner image placeholder]
2
-
3
- # Auto-BG
4
- LLM-based text generation tool for creating board game concepts (description & title)
5
-
6
- The Auto-BG (Board Game) tool is a text generation tool for creating board game concepts. It utilizes multiple large-language models to generate board game titles and descriptions tailored from user-input tags based on BoardGameGeek.com. The models used in this project include a trained T5 sequence-to-sequence model, primarily for title generation, and a robust GPT3 model for board game description generation. The T5 model was initially presented by Raffel et al. in ["Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer"](https://arxiv.org/pdf/1910.10683.pdf). The GPT3 model builds from Brown et al.'s work in ["Language Models are Few-Shot Learners"](https://arxiv.org/pdf/1910.10683.pdf).
7
-
8
-
9
- ## Table of Contents
10
- - Features and Demo
11
- - Examples
12
- - Project Structure
13
- - Customizing Auto-BG
14
- - Citations and Licensing
15
-
16
- ## Features and Demo
17
- The main features of this application include:
18
-
19
- A user-friendly interface for Auto-BG can be found at (homepage).
20
-
21
- ## Examples
22
-
23
- ## Project Structure
24
-
25
- ## Customizing Auto-BG
26
- NOTE: Auto-BG uses a fine-tuned GPT-3 Curie model that will be inaccessible without an organizational API key,
27
- the below instructions are for advanced users interested in remixing Auto-BG with a new generator model.
28
-
29
- In order to run this application, you will need the following:
30
- 1. An OpenAI account and API key
31
- 2. All libraries specified in both the primary and data processing requirements.txt files
32
- 3. A raw stream JSON file of BoardGameGeek data, formatted to match output from the Recommend.Games scraper
33
-
34
- To implement a new instance of Auto-BG, follow these steps:
35
- 1. Clone the repository onto your local machine
36
- 2. Install the required packages listed in both 'requirements.txt' files using pip
37
- 3. Download the trained T5 model or provide a path to an alternate T5 model.
38
- 4. Placing the JSON data file in Stream_to_Output, run GameCleaner.py - this provides all required data files.
39
-
40
- 5. Prepare training prompts - convert all active keys to period stopped tokens in a string for each game.
41
- 6. Fine-tune a selected model following the instructions at: https://platform.openai.com/docs/guides/fine-tuning
42
- NOTE: Auto-BG uses a Curie model with a lowered learning rate running for fewer epochs.
43
-
44
- 8. Create a Model_Constants.py file with your personal API key and model instance based on the template above.
45
- 9. You now have a customized instance of Auto-BG!
46
-
47
- ## Citations and Licensing
48
- Auto-BG is licensed under CC BY-NC-SA 2.0, original data sourced from Recommend.Games @GitLab
 
1
+ ---
2
+ title: Auto BoardGame
3
+ emoji: 🎲
4
+ colorFrom: indigo
5
+ colorTo: indigo
6
+ sdk: streamlit
7
+ sdk_version: 1.19.0
8
+ app_file: Home.py
9
+ pinned: false
10
+ license: cc-by-nc-sa-2.0
11
+ ---