keefereuther commited on
Commit
19acbf6
·
verified ·
1 Parent(s): 9718a4c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +2 -61
README.md CHANGED
@@ -1,10 +1,10 @@
1
  ---
2
- title: Schema Study for BILD 5
3
  emoji: 📚
4
  colorFrom: pink
5
  colorTo: gray
6
  sdk: streamlit
7
- sdk_version: 1.44.0
8
  app_file: app.py
9
  pinned: true
10
  license: gpl-3.0
@@ -33,65 +33,6 @@ Schema Study enhances the learning experience by:
33
  - **AI-Enhanced Feedback:** Utilizes OpenAI's GPT-4o model to provide detailed explanations and formative feedback.
34
  - **Interactive Chat:** Engages students in a dialogue with the AI chatbot to deepen their understanding.
35
 
36
- ## How the App Works
37
-
38
- ### For Students
39
-
40
- 1. **Access the App:** Open your web browser and navigate to `http://localhost:8501`. Enter the password when prompted.
41
- 2. **Upload Terms:** Use the sidebar file uploader to upload a CSV file containing terms and schemas. The file should have two columns: `TERM` and `SCHEMA`.
42
- 3. **Start Studying:** Click the button to select a random term and begin your interactive study session with the AI chatbot.
43
- 4. **Engage with the AI:** Use the chat interface to ask questions and receive feedback on your understanding of the term.
44
-
45
- ### For Instructors
46
-
47
- 1. **Clone the Repository:**
48
-
49
- ```bash
50
- git clone https://github.com/keefereuther/schema_study.git
51
- cd schema_study
52
- ```
53
-
54
- 2. **Install the Required Packages:**
55
-
56
- ```bash
57
- pip install -r requirements.txt
58
- ```
59
-
60
- 3. **Set Up Your Configuration:**
61
-
62
- Update the `config.py` file with your desired settings.
63
-
64
- 4. **Create a '.streamlit/secrets.toml' file and directory.**
65
-
66
- Add your OpenAI API key and the app password:
67
-
68
- ```toml
69
- [general]
70
- OPENAI_API_KEY = "your-openai-api-key"
71
- password = "your-app-password"
72
- ```
73
-
74
- 5. **Run the App:**
75
-
76
- ```bash
77
- streamlit run app.py
78
- ```
79
-
80
- ## Configuration
81
-
82
- The `config.py` file contains customizable settings for the app. Key settings include:
83
-
84
- - `app_title`: The title of the app.
85
- - `app_author`: Author information.
86
- - `instructions`: Instructions for using the app.
87
- - `sidebar_title`: Title for the sidebar section.
88
- - `default_terms_csv`: Default CSV file for terms.
89
- - AI model settings like `ai_model`, `temperature`, `max_tokens`, `frequency_penalty`, and `presence_penalty`.
90
-
91
- ## Contributing
92
-
93
- Contributions are welcome! Please fork the repository and submit pull requests for any improvements or bug fixes.
94
-
95
  ## License
96
 
97
  This project is licensed under the GNU GPL-3 License - see the [LICENSE](LICENSE) file for details.
 
1
  ---
2
+ title: Schema Study Instructor Evaluation Version
3
  emoji: 📚
4
  colorFrom: pink
5
  colorTo: gray
6
  sdk: streamlit
7
+ sdk_version: 1.45.0
8
  app_file: app.py
9
  pinned: true
10
  license: gpl-3.0
 
33
  - **AI-Enhanced Feedback:** Utilizes OpenAI's GPT-4o model to provide detailed explanations and formative feedback.
34
  - **Interactive Chat:** Engages students in a dialogue with the AI chatbot to deepen their understanding.
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  ## License
37
 
38
  This project is licensed under the GNU GPL-3 License - see the [LICENSE](LICENSE) file for details.