贡献代码

可自由贡献classifiers, backbones, functions及其他任何改进。

增加一个方法/特性或修复一个错误

我们建议参考如下方法：

  1. fork main分支的最新LibFewShot代码

  2. checkout 一个新的分支，分支的名字应该能够直观表现本次contribution的主要内容，如add-method-demo或者fix-doc-typos

  3. commit

  4. create a PR

注意，如果你添加了一个方法，你需要做的是

  1. 测试该方法的表现是否正常

  2. 提供你复现该方法使用的config文件，以及对应的在miniImageNet上的1-shot和5-shot精度。 以及，您最好能提供：

  3. 在其它数据集（如tieredImageNet）上的1-shot和5-shot精度

  4. 对应的model_best.pth文件（以zip文件格式） 我们会在README和其它显眼的地方感谢您的贡献。

使用 pre-commit 检查代码

在提交你的代码之前，你的代码需能够通过 black 的格式化以及 flake8 ，我们使用 pre-commit 进行测试和自动修订：

  1. 首先安装 pre-commit

cd <path-to-LibFewShot>
pip install pre-commit

  1. run pre-commit install

  2. run pre-commit run --all-files

  3. 根据pre-commit给出的warning修改代码

PR style

你的PR请求标题应该如下：

[Method] XXXX XXXX
# 或者
[Feature] XXXX XXXX
# 或者
[FIX] XXXX XXXX

PR请求的正文内容应该使用英文/中文简要描述本次PR的主要内容。