Skip to content

Commit a6098b6

Browse files
committed
2 parents c2719c1 + 44501cd commit a6098b6

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

app/streamlit_app.py

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,43 @@ class App:
4141
[![Twitter](https://badgen.net/badge/icon/Twitter?icon=twitter&label)](https://twitter.com/pytorch_ignite)
4242
[![GitHub](https://badgen.net/badge/icon/GitHub?icon=github&label)](https://github.com/pytorch-ignite/code-generator)
4343
[![Release](https://badgen.net/github/tag/pytorch-ignite/code-generator?label=release)](https://github.com/pytorch-ignite/code-generator/releases/latest)
44+
4445
</div>
46+
47+
<details>
48+
49+
<summary>
50+
<samp>Learn More</samp>
51+
</summary>
52+
53+
#### Code Generator, what is it ?
54+
55+
- "Code Generator" is a streamlit application to produce quick-start python code
56+
for common training tasks in deep learning.
57+
- Code is using PyTorch framework and PyTorch-Ignite library can be configured using the UI.
58+
59+
#### Why to use Code Generator ?
60+
61+
- Start working on a task without rewriting everything from scratch: Kaggle competition, client prototype project, etc.
62+
63+
</details>
64+
65+
<details open="true">
66+
<summary>
67+
<samp>Get Started</samp>
68+
</summary>
69+
70+
#### How to use it ?
71+
72+
1. 📃 Choose a Template.
73+
2. ⚙️ Adjust the configuration in the left sidebar. _(click on > if closed)_
74+
3. 🔬 Inspect the code in the central widget.
75+
4. 📦 Download the source code.
76+
5. 🚀 Use it for your project.
77+
78+
</details>
79+
80+
---
4581
"""
4682

4783
def __init__(self):
@@ -65,7 +101,7 @@ def sidebar(self, template_list=None, config=None):
65101

66102
def render_code(self, fname: str = "", code: str = ""):
67103
"""Main content with the code."""
68-
with st.beta_expander(fname, expanded=fname.endswith(".md")):
104+
with st.beta_expander(fname):
69105
if fname.endswith(".md"):
70106
st.markdown(code, unsafe_allow_html=True)
71107
else:

0 commit comments

Comments
 (0)