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.Tensoronly (for all tensors/shapes/devices); do not use any more specific annotations (e.g.,torch.LongTensorrefers to a CPU tensor only, but not a CUDA tensor)
- For tensors, use
- Unspecified configuration values are indicated by
''for strings-1for non-negative integers.nanfor floats
- Don't issue pull request for datasets or experimental code to this repository.