💎A site, that contains systematic optimization methods review
- Fork this repository to your own account (Fork button at the top right corner)
- Create a branch in your repository (locally or remotely). Let's name it
contributionbranch - Commit your changes\ fixes\ additions to this branch
- Send your pull request to the
masterbranch of the original repository.
- All materials are available in
kramdownversion of Markdown. It is pretty simple, some syntax cheatsheet could be found on the site. - All formulas (both inline and block style) should be arranged with double dollar sign (
$$ x^2 $$stands for inline, if you'll arrange it with new line symbols, you'll recieve block style) due to kramdownpreprocessor. - If you want to place just one inline formula on the paragrah, please write this way:
\$$ x^2 $$(weird, I know).
- Figures and graphs should be in
.svgvector format if possible. - By default all pictures are centered and has 75% of linewidth. However, if you will use
#buttonsuffix at the end of the path (or url) to the picture, it will be displayed in inline style with 150px in width (was primarly done forbuttons).
- Titles of the pages should start from the capital letter. Do not use abbreviation style of naming:
Gradient descent✅, whileGradient Descent❎,GD❎ - You can include the link to some page of the site right in the text through the following syntax:
{% raw %}{% include link.html title="Excersises"%}{% endraw %}, where you should place only the name of the page in title field. One more example:{% raw %}{% include link.html title="Gradient descent"%}{% endraw %}. It is useful, because it is robust to the structure changes in this site.
[](%LINK TO THE SHARED COLAB NOTEBOOK%) buttons)stands for the{% include tabs.html bibtex = '@article{kingma2014adam, title={Adam: A method for stochastic optimization}, author={Kingma, Diederik P and Ba, Jimmy}, journal={arXiv preprint arXiv:1412.6980}, year={2014} }' file='PATH_TO_THE_FILE'%}will display
- The jekyll template was taken from Just the docs and modified