How to start your DS / ML / AI / Tech blog with a minimum of complexities associated with hosting and deploying this blog.
At the end of February 2020, the guys from fast.ai
introduced the world fastpages
to a blogging platform. I will note that it is fastpages
based on Jekyll
, about which there are many posts on HabrΓ©.
An example of a blog on the engine fastpages
is this blog .
The main distinguishing feature and advantage fastpages
is the supported post formats out of the box:
- Jupyter notebooks (extension
.ipynb
); - Markdown files (extension
.md
); - Word files (extension
.docx
)
Thus, the blog author needs to save the post in any of the above formats in the appropriate directory:
- './_notebooks/' for
.ipynb
; - './_posts/' for
.md
; - './_word/' for
.docx
.
And he will do the rest fastpages
, according to its authors.
fastpages
uses Github Pages for hosting and Github Actions to automate post publishing.
As I understand it, this fastpages
is a refinement of the Github Pages + bundle Jekyll
, where you can immediately get the published post from the Jupyter laptop.
Creating a blog with fastpages
andGitHub
fastpages
:
. ./_config.yml
, :
title
β , ;
description
β , (, );
github_username
β GitHub ;
github_repo
β , GitHub, Google Colab Binder Jupyter ;
default_badges
β GitHub, Google Colab Binder Jupyter . , ,default_badges
true
false
. , Binder,default_badges
:
default_badges: github: true binder: false colab: true
url
β , ;
baseurl
β . /_config.yml ("Special Instructions for baseurl"). , ;
twitter_username
β Twitter;
use_math
βtrue
,LaTeX
;
show_description
β .true
;
google_analytics
β Google Analytics;
pagination
β , . 15. , , :
show_tags
β , :
show_image
βtrue
. ( 2 ):
.ipynb
fastpages
- ( :
.ipynb
,.md
.docx
) (./_notebooks
,./_posts
./_word
).2020-05-26-DS-fastpages-blog.ipynb
. Jekyll ( ).
:
-
YYYY-MM-DD-
; - , , .
-
- commit push GitHub
master
. - GitHub . ~5 . Β«ActionsΒ» GitHub. workflow,
push
master
:
- Check Configurations β (, ), ;
- CI β ;
- GH Pages Status β .
, .
- , , . .
,fastpages
.
Jupyter ( Markdown ) , / .
# "Title"
> "Awesome summary"
- toc: true
- branch: master
- badges: true
- comments: true
- author: Hamel Husain & Jeremy Howard
- categories: [fastpages, jupyter]
Markdown , , .. ---
.
:
---
title: "Title"
description: "Awesome description"
toc: true
layout: post
categories: [markdown]
---
, , YAML . , : - title: "Deep learning: A tutorial"
YAML.
toc
βtrue
, Markdown ;badges
[notebooks only] βtrue
Google Colab
,Binder
GitHub
, ;hide_github_badge
[notebooks only] βtrue
GitHub
;hide_colab_badge
[notebooks only] βtrue
Google Colab
;hide_binder_badge
[notebooks only] βtrue
Binder
;branch
[notebooks only] β Jupyter Colab GitHub. :master
;comments
βtrue
( );author
βtrue
;categories
β ( "Tags").image
β , . (Twitter) :
- β
images/figure.png
; -
/images
;
- β
search_exclude
β (Search
), , ;hide
βtrue
, :
- permalinks ;
-
search_exclude
true
, (Search
);
sticky_rank
β , . , .
/ . ( ), , .
#hide
β , ;#hide_input
β ;#collapse-hide
β , , ;#collapse-show
β , .
Altair
Jupyter .
:
![](https://www.fast.ai/images/fastai_paper/show_batch.png "Credit: https://www.fast.ai/2020/02/13/fastai-A-Layered-API-for-Deep-Learning/")
:
, , ( ), ( ).
.
Youtube
Youtube :
> youtube: https://youtu.be/L0boq3zqazI
Twitter.
,
> twitter: https://twitter.com/jakevdp/status/1204765621767901185?s=20
:
LaTeX
Jupyter LaTeX
. , , use_math
_config.yml
(. ).
LaTeX
:
> $$L(\theta) = \frac{1}{N} \sum_i^N{(y_i - \hat{y_i})^2} \rightarrow \min_{\theta}$$
:
.
: > Warning: There will be no second warning!
: > Important: Pay attention! It's important.
: > Tip: This is my tip.
: > Note: Take note of this.
, .
,
> Note: A doc link to [an example website: fast.ai](https://www.fast.ai/) should also work fine.
:
Emoji
:robot:.
:
:robot:.
{% raw %}For example, here is a footnote {% fn 1 %}.
And another {% fn 2 %}
{{ 'This is the footnote.' | fndetail: 1 }}
{{ 'This is the other footnote. You can even have a [link](https://fastpages.fast.ai/jupyter/2020/02/20/test.html#Footnotes)' | fndetail: 2 }}{% endraw %}
fastpages
fastpages
nbdev jupyter , word .md
. , /_notebooks
, /_word
/_posts
, GitHub Actions c nbdev , .
fast_template
β fastpages
, fast.ai
fast_template, , Word Jupyter , . fastpages
, , .
, fast_template
, . - Github, git
.
- ;
- Jupyter + :
- ;
- / ;
- GIF-;
- youtube .
- Medium;
- url;
-
badges
GitHub
,Binder
,Google Colab
, ; - ;
-
sticky_rank
, ; - ;
- , :
- permalinks;
- ;
- , , (, ) , - .
- WYSIWYG (What You See Is What You Get):
-
Jekyll
, . Jekyll
git
;- Jupyter ;
- , spell checker Jupyter .
fast.ai DS , , .
, git
, Markdown Jupyter Notebook. , .
, , , . pull request
, .
, .
DS/ML/AI
-
fastpages
by Scott H. Hawley; - ;
- Andrej Karpathy github.io, medium;
- Machine Learning Mastery by Jason Brownlee;
- Fast.ai + fastpages blog;
- Airbnb;
- Uber;
- OpenAI;
- DeepMind;
- Nvidia + AI podcast;
- Microsoft AI blog + ML devblogs
-
fastpages
; - Introducing fastpages;
- ,
.ipynb
; -
fast_template
+ fast.ai; - Project home page
nbdev
+ repository + forum ; - A fairly broad overview of blog engines;
- More blogs [ 1 , 2 ];