Skip to content

Commit

Permalink
Add coding conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
titusz committed Oct 19, 2024
1 parent db38dab commit 41a97c8
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Coding Convetions

- Write pragmatic, easily testable, and performant code!
- Prefer short and pure functions where possible!
- Keep the number of function arguments as low as possible!
- Don´t use nested functions!
- Write concise and to-the-point docstrings for all functions!
- Use type comments style (PEP 484) instead of function annotations!
- Always add a correct PEP 484 style type comment as the first line after the function definition!
- Use built-in collection types as generic types for annotations (PEP 585)!
- Use the | (pipe) operator for writing union types (PEP 604)!

Example function with type annotations and docstring:

```python
def tokenize_chunks(chunks, max_len=None):
# type: (list[str], int|None) -> dict
"""
Tokenize text chunks into model-compatible formats.
:param chunks: Text chunks to tokenize.
:param max_len: Truncates chunks above max_len characters
:return: Dictionary of tokenized data including input IDs, attention masks, and type IDs.
"""
```

0 comments on commit 41a97c8

Please sign in to comment.