#Algorithm

#Software

Meaning of Abbreviations

Shortcut Description
PR Pull Request
PTAL Please Take A Look
TBR To Be Reviewed
TL;DR Too Long; Didn’t Read
LGTM Looks Good To Me
SGTM Sounds Good To Me
TBD To Be Done

Environment

Linux

#Python

#Julia

#CI/CD

Version Control

Workflow/Pipeline/MLops

Crontab
Jenkins
Github action
Airflow
mage-ai

The modern replacement for Airflow. Build, run, and manage data pipelines for integrating and transforming data.

  1. https://github.com/mage-ai/mage-ai
wandb

A tool for visualizing and tracking your machine learning experiments.

  1. https://github.com/wandb/wandb
Drone CI
Flyte
  1. An open-source orchestrator that facilitates building production-grade data and ML pipelines
datachecks

Datachecks is an open-source data monitoring tool that helps to monitor the data quality of databases and data pipelines. It identifies potential issues, including in the databases and data pipelines. It helps to identify the root cause of the data quality issues and helps to improve the data quality.

  1. https://github.com/waterdipai/datachecks

Logs

hydra

A framework for elegantly configuring complex applications

  1. https://github.com/facebookresearch/hydra
whylogs

The open standard for data logging

  1. https://github.com/whylabs/whylogs

#git

Commit message Convention

Type Description
feat Add new features
chore Build process or auxiliary tool changes
fix Fix some bugs
refactor A code change that neither fixes a bug or adds a feature
style Change coding style
docs Write new documentation

Branch Naming Convention

Type Description
wip Works in progress
feat Feature
bug Bug fix or experiment
junk Throwaway branch created to experiment

Rebase

Commands Description
pick 保留該提交,不進行任何更改
reword 修改該提交的提交訊息
edit 挑選該提交,並在應用該提交時停止,以便你可以進行修改
squash 將該提交與前一個提交合併成一個提交
fixup 與 squash 類似,但用於合併提交而無需保留該提交的提交訊息
exec 執行一個 shell 命令。這允許你在 rebase 過程中執行自定義的命令