Spaces:
Runtime error
Runtime error
File size: 38,164 Bytes
1956c42 0964b21 1956c42 0d28304 19dae2b 184656d e6fe198 d2089ad 046fa79 53b8788 39388ba 04588d1 3d9a022 7417495 752088d f7234de 0d28304 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
---
title: Personal Tutor
emoji: 🌖
colorFrom: red
colorTo: pink
sdk: docker
app_file: app.py
pinned: false
license: lgpl-3.0
---
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
# **Duplication and Deployment Instructions for Huggingface Spaces**
This README contains duplication and deployment instructions for CLAS applications deployed with Huggingface Spaces. These apps allow students to interact with a chatbot tutor which provides quiz questions, feedback, and academic guidance on the subject.
After the conversation is over, a JSON file with chat history will be available for download.
## **How to duplicate the Huggingface Space**
An instructor must duplicate a Space if they wish to build from an existing demo to make changes or incorporate specific environment variables.
If you want to duplicate a Space, click the three dots at the top right of the space and click Duplicate this Space. Once you do this, you will be able to change the following attributes:
**Owner**: The duplicated Space can be under your account or any organization in which you have write access
**Space name**
**Visiblity**: The Space is private by default. Read more about private repositories here.
**Hardware**: You can choose the hardware on which the Space will be running. Read more about hardware upgrades here.
**Storage**: If the original repo uses persistent storage, you will be prompted to choose a storage tier. Read more about persistent storage here.
**Secrets and variables**: If the original repo has set some secrets and variables, you’ll be able to set them while duplicating the repo.
If the Space requires utilizes environment variables, the duplicate workflow will auto-populate the public Variables from the source Space, and give you a warning about setting up the Secrets. The duplicated Space will use a free CPU hardware by default, but you can later upgrade if needed.
## **How to manage Huggingface Secrets**
Repository Secrets store values including access tokens, API keys, or any sensitive value or credentials. Secrets are private and their value cannot be retrieved once set. They will not be added to Spaces duplicated from your repository.
Commonly used secret variables may include "OPENAI_API_KEY", "SECRET_PROMPT", and "PIPLOC." Instructions for inputting values into these variables are below.
1. The input for the "OPENAI_API_KEY" secret can be the instructor's personal OpenAI API key. If you do not already have an API key, navigate to the API section of the OpenAI website. Click to generate a new API key and save this value in a secure location.
2. The input for "SECRET_PROMPT" includes the persona and prompt given to the chatbot tutor to guide its interaction with students.
3. The input for "PIPLOC" allows the app to access other files in the CLAS project. The input is a value in the following form: git+https://ghusername:ghpersonalaccesstoken@github.com/vanderbilt-data-science/lo-achievement.git with "ghusername" replaced by your personal Github username and "ghpersonalaccesstoken" replaced by your Github personal access token.
|