DilipKY commited on
Commit
6fd1405
·
verified ·
1 Parent(s): 87a0fd9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -1
README.md CHANGED
@@ -10,5 +10,29 @@ pinned: false
10
  license: mit
11
  short_description: code gen bot
12
  ---
 
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: mit
11
  short_description: code gen bot
12
  ---
13
+ Check out the configuration reference at [https://huggingface.co/docs/hub/spaces-config-reference](https://huggingface.co/docs/hub/spaces-config-reference)
14
 
15
+ # Code Generation Bot
16
+
17
+ This is a simple bot that generates Python code from natural language descriptions using the CodeGen-350M-mono model from Hugging Face.
18
+
19
+ ## How to Use
20
+ 1. Enter a description of the code you want (e.g., "Write a function to calculate factorial").
21
+ 2. Click "Generate Code" to see the output.
22
+ 3. Review the generated code for correctness before copying it.
23
+
24
+ ## Tips
25
+ - Be specific in your descriptions for better results (e.g., "Write a Python function to add two numbers and return the sum").
26
+ - The generated code may need minor tweaks, as it’s AI-generated.
27
+
28
+ ## About
29
+ - **Model:** Salesforce/codegen-350M-mono
30
+ - **Framework:** Streamlit
31
+ - **Deployment:** Hosted on Hugging Face Spaces
32
+
33
+ ## Example
34
+ - **Input:** "Write a function to add two numbers"
35
+ - **Output:**
36
+ ```python
37
+ def add_numbers(a, b):
38
+ return a + b