milwright commited on
Commit
8d2d3d0
·
verified ·
1 Parent(s): ed6857b

Update support_docs.py

Browse files
Files changed (1) hide show
  1. support_docs.py +19 -17
support_docs.py CHANGED
@@ -34,24 +34,26 @@ def create_support_docs():
34
  with gr.Accordion("📝 Step 1: Configure Your Space", open=False):
35
  gr.Markdown("""
36
  ### Configuration Tab Sections
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
- **1a. Templates & Identity** Included are several pre-populated templates to get you started with playful (but applied) configurations. Or start with the "None (Custom)" option for a blank slate. Personalize the chat u/i and giving it a name, header (max 60 char) and a markdown description for the `README.md` file, then select from Gradio themes like Default, Soft, Glass, Monochrome, or Base.
39
-
40
- **1b. Model Configuration**: Craft a system prompt that steers your model's behavior using a well-defined role, context and audience, code of conduct, and/or terms of engagement——think of guardrails as creative constraints. Afterward select a model ID from the menu of options, then experiment with sampling parameters, adjusting temperature (values from 0 to 2) to control response variability and/or setting a token response limit (between 50-4096) to cap output.
41
-
42
- **1c. Example Prompts**: Add 3 to 5 starter prompts that showcase the purpose and design of your space. These examples appear as quick-start buttons for users to try and meant to help them get started.
43
-
44
- **1d. URL Grounding**: Add up to 10 reference URLs that ground the model in the context of different webpages. The first 2 URLs function as primary sources that will always be loaded with each query, while other URLs serve as supplementary context. Note that only 4096 total characters from URLs are appended to the system prompt.
45
-
46
- **1e. API Key and HuggingFace Token**
47
-
48
- - Required: Provide the required OpenAI-standard API key (`sk-`) and name for its variable (`API_KEY`) to call the model through a provider like OpenRouter
49
-
50
- - Recommended: Add a HuggingFace token (`HF_TOKEN`) to make your space customizable over time through a configuration editor
51
-
52
- - Optional: Set an optional password (`ACCESS_CODE`) to limit who can access your space. Any value goes.
53
-
54
- **1f. Upload `config.json`**: Done this before? Upload an existing `config.json` files to redeploy your Space with new settings and recent versions.
55
  """)
56
 
57
  with gr.Accordion("💬 Step 2: Preview Your Assistant", open=False):
 
34
  with gr.Accordion("📝 Step 1: Configure Your Space", open=False):
35
  gr.Markdown("""
36
  ### Configuration Tab Sections
37
+
38
+ #### 1a. Templates & Identity
39
+ Included are several pre-populated templates to get you started with playful (but applied) configurations. Or start with the "None (Custom)" option for a blank slate. Personalize the chat u/i and giving it a name, header (max 60 char) and a markdown description for the `README.md` file, then select from Gradio themes like Default, Soft, Glass, Monochrome, or Base.
40
+
41
+ #### 1b. Model Configuration
42
+ Craft a system prompt that steers your model's behavior using a well-defined role, context and audience, code of conduct, and/or terms of engagement——think of guardrails as creative constraints. Afterward select a model ID from the menu of options, then experiment with sampling parameters, adjusting temperature (values from 0 to 2) to control response variability and/or setting a token response limit (between 50-4096) to cap output.
43
+
44
+ #### 1c. Example Prompts
45
+ Add 3 to 5 starter prompts that showcase the purpose and design of your space. These examples appear as quick-start buttons for users to try and meant to help them get started.
46
+
47
+ #### 1d. URL Grounding
48
+ Add up to 10 reference URLs that ground the model in the context of different webpages. The first 2 URLs function as primary sources that will always be loaded with each query, while other URLs serve as supplementary context. Note that only 4096 total characters from URLs are appended to the system prompt.
49
+
50
+ #### 1e. API Key and HuggingFace Token
51
 
52
+ - **Required**: Provide the required OpenAI-standard API key (`sk-`) and name for its variable (`API_KEY`) to call the model through a provider like OpenRouter.
53
+ - **Recommended**: Add a HuggingFace token (`HF_TOKEN`) to make your space customizable over time through a configuration editor.
54
+ - **Optional**: Set an optional password (`ACCESS_CODE`) to limit who can access your space. Any value goes.
55
+
56
+ #### 1f. Upload `config.json`Done this before? Upload an existing `config.json` files to redeploy your Space with new settings and recent versions.
 
 
 
 
 
 
 
 
 
 
 
 
57
  """)
58
 
59
  with gr.Accordion("💬 Step 2: Preview Your Assistant", open=False):