Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
22 lines (19 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

22 lines (19 loc) · 1.01 KB

Guidelines

Thank you for considering to contribute to this project. We currently have the following rules for contributing to this repository:

  • Code formatting using black and with default settings (line length 88)
  • Code documentation following Google Python Style Guide (Sec. 3.8); see example
  • Use type annotations whenever considered helpful
    • For tensors, use torch.Tensor only (for all tensors/shapes/devices); do not use any more specific annotations (e.g., torch.LongTensor refers to a CPU tensor only, but not a CUDA tensor)
  • Unspecified configuration values are indicated by
    • '' for strings
    • -1 for non-negative integers
    • .nan for floats
  • Don't issue pull request for datasets or experimental code to this repository.