Skip to content

Commit 15a8ca0

Browse files
committed
update content
1 parent 22839f2 commit 15a8ca0

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,15 @@ available commands:
109109
nbdev_preview Start a local docs webserver
110110
nbdev_pypi Create and upload Python package to PyPI
111111
nbdev_quarto Create Quarto docs and README.md
112+
nbdev_readme Render README.md from index.ipynb
112113
nbdev_release Release both conda and PyPI packages
113114
nbdev_sidebar Create sidebar.yml
114115
nbdev_test Test in parallel notebooks matching `fname`, passing along `flags`
115116
nbdev_trust Trust notebooks matching `fname`
116117
nbdev_update Propagate change in modules matching `fname` to notebooks that created them
117118

119+
## FAQ
120+
118121
### Q: Someone told me not to use notebooks for “serious” software development!
119122

120123
[Watch this video](https://youtu.be/9Q6sLbz37gk). Don’t worry, we still
@@ -125,6 +128,20 @@ clients](https://github.com/fastai/ghapi), [Python language
125128
extensions](https://github.com/fastai/fastcore), [terminal user
126129
interfaces](https://github.com/nat/ghtop), and more!
127130

131+
## nbdev in the wild
132+
133+
### fastai ecosystem
134+
135+
`nbdev` has been used to build innovative software in the fastai
136+
ecosystem, including the [`fastai`](https://docs.fast.ai/) deep learning
137+
library which implements a [unique layered API and callback
138+
system](https://arxiv.org/abs/2002.04688), and
139+
[`fastcore`](https://fastcore.fast.ai/), which supercharges Python
140+
leveraging its dynamic nature. Furthermore, `nbdev` allows a very small
141+
number of developers to maintain and grow a [large
142+
ecosystem](https://github.com/fastai) of software engineering, data
143+
science, machine learning, and devops tools.
144+
128145
## Contributing
129146

130147
If you want to contribute to `nbdev`, be sure to review the

nbs/getting_started.ipynb

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
},
109109
{
110110
"cell_type": "code",
111-
"execution_count": null,
111+
"execution_count": 1,
112112
"metadata": {},
113113
"outputs": [
114114
{
@@ -135,6 +135,7 @@
135135
"\u001b[1m\u001b[94mnbdev_preview\u001b[0m Start a local docs webserver\n",
136136
"\u001b[1m\u001b[94mnbdev_pypi\u001b[0m Create and upload Python package to PyPI\n",
137137
"\u001b[1m\u001b[94mnbdev_quarto\u001b[0m Create Quarto docs and README.md\n",
138+
"\u001b[1m\u001b[94mnbdev_readme\u001b[0m Render README.md from index.ipynb\n",
138139
"\u001b[1m\u001b[94mnbdev_release\u001b[0m Release both conda and PyPI packages\n",
139140
"\u001b[1m\u001b[94mnbdev_sidebar\u001b[0m Create sidebar.yml\n",
140141
"\u001b[1m\u001b[94mnbdev_test\u001b[0m Test in parallel notebooks matching `fname`, passing along `flags`\n",
@@ -147,6 +148,13 @@
147148
"!nbdev_help"
148149
]
149150
},
151+
{
152+
"cell_type": "markdown",
153+
"metadata": {},
154+
"source": [
155+
"## FAQ"
156+
]
157+
},
150158
{
151159
"cell_type": "markdown",
152160
"metadata": {},
@@ -161,6 +169,25 @@
161169
"[Watch this video](https://youtu.be/9Q6sLbz37gk). Don't worry, we still get this too, despite having used `nbdev` for a wide range of \"very serious\" software projects over the last three years, including [deep learning libraries](https://github.com/fastai/fastai), [API clients](https://github.com/fastai/ghapi), [Python language extensions](https://github.com/fastai/fastcore), [terminal user interfaces](https://github.com/nat/ghtop), and more!"
162170
]
163171
},
172+
{
173+
"cell_type": "markdown",
174+
"metadata": {},
175+
"source": [
176+
"## nbdev in the wild\n",
177+
"\n",
178+
"### fastai ecosystem\n",
179+
"\n",
180+
"`nbdev` has been used to build innovative software in the fastai\n",
181+
"ecosystem, including the [`fastai`](https://docs.fast.ai/) deep learning\n",
182+
"library which implements a [unique layered API and callback\n",
183+
"system](https://arxiv.org/abs/2002.04688), and\n",
184+
"[`fastcore`](https://fastcore.fast.ai/), which supercharges Python\n",
185+
"leveraging its dynamic nature. Furthermore, `nbdev` allows a very small\n",
186+
"number of developers to maintain and grow a [large\n",
187+
"ecosystem](https://github.com/fastai) of software engineering, data\n",
188+
"science, machine learning, and devops tools."
189+
]
190+
},
164191
{
165192
"cell_type": "markdown",
166193
"metadata": {},

0 commit comments

Comments
 (0)