SandeepU commited on
Commit
ce63d75
·
verified ·
1 Parent(s): a9ad0c9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -14
README.md CHANGED
@@ -1,23 +1,24 @@
1
- # Code Explainer 🧠
 
 
 
 
 
 
 
 
 
2
 
3
- This project uses the `bigcode/starcoder` model to explain Python code in plain English.
4
 
5
- ## How to Run
6
 
7
- ```bash
8
- pip install -r requirements.txt
9
- streamlit run app/main.py
10
- ```
11
 
12
- ## Example
13
-
14
- Input:
15
  ```python
16
  def fibonacci(n):
17
  if n <= 1:
18
  return n
19
  return fibonacci(n-1) + fibonacci(n-2)
20
- ```
21
-
22
- Output:
23
- > This function calculates the nth Fibonacci number using recursion...
 
1
+ ---
2
+ title: Code Explainer 💡
3
+ emoji: 🧠
4
+ colorFrom: indigo
5
+ colorTo: purple
6
+ sdk: streamlit
7
+ sdk_version: "1.35.0"
8
+ app_file: streamlit_app.py
9
+ pinned: false
10
+ ---
11
 
12
+ # 🧠 Code Explainer Explain Any Python Code in Plain English
13
 
14
+ This Streamlit app uses the `bigcode/starcoder` model to generate step-by-step explanations for Python code snippets.
15
 
16
+ ## 🚀 Live Demo
17
+ Paste Python code in the text box and get a natural language explanation generated by an AI model trained on billions of lines of code.
 
 
18
 
19
+ ### Example
 
 
20
  ```python
21
  def fibonacci(n):
22
  if n <= 1:
23
  return n
24
  return fibonacci(n-1) + fibonacci(n-2)