ml-template

My personal code snippet library of helper functions and classes, some with example.

• +itom/: Tool functions that might be used in MATLAB codes. The leading + will add this folder into the searching path.

• configurations/: Configuration files.

• containers/: Definition files of Docker and Singularity image.

• git/: git-related command showcases and .gitignore template.

• latex/: LaTeX preamble template for academic papers and a rebuttal analysis Excel template.

• losses/: Implementation of some deep learning loss functions.

• scripts/: Utility scripts.

• utils/: Utilities.

• args.py: An example of using the argparse package in Python.

• config.yaml: An example of writing arguments in YAML. Can be used together with utils/config.py.

• requirements.txt: Common packages I met that a Docker image may not contain.

badge

Sometimes you may want to create a badge in your GitHub repository README. Use Shields.io to make one. See Static Badge for basic usage. In markdown, you make one by inserting a:

![SOME_ALTERNATIVE_TEXT](https://img.shields.io/badge/:badgeContent)

where :badgeContent has to be replaced by some fields. For example, a badge of this repository can be :

![iTomxy/ml-template](https://img.shields.io/badge/iTomxy-ml--template-blue?logo=github)

where:

• iTomxy-ml--template-blue is a --separated string, containing 3 fields: 1) left part text, 2) right part text, and 3) right part background colour.
• logo specifies the logo shown in the left part. The logo name should be from Simple Icons.

If you also want to add a hyperlink on the badge instead of letting it be a pure icon, you just wrap it with [badge-code](link) :

[![iTomxy/ml-template](https://img.shields.io/badge/iTomxy-ml--template-blue?logo=github)](https://github.com/iTomxy/ml-template)

Althoug the Shilds.io badge supports inserting link by itself (see Static Badge), but it seems that this is not usable in GitHub (see How to specify the link of left and right on GitHub #5593).