Refactor copyright notice

aurora/__init__.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 from aurora.model.aurora import Aurora, AuroraSmall
 

aurora/area.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 import torch
 

aurora/batch.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 import dataclasses
 from datetime import datetime

aurora/model/__init__.py

@@ -1,3 +1 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""

aurora/model/aurora.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 from datetime import timedelta
 from functools import partial

aurora/model/film.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 import torch
 from torch import nn

aurora/model/fourier.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 import math
 

aurora/model/groupedpatchembed.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 import math
 from collections.abc import Iterable

aurora/model/helpers.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 from typing import TypeVar
 

aurora/model/lora.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 import math
 from typing import Literal

aurora/model/perceiver.py

@@ -1,11 +1,11 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license.
 
 Basic blocks for the Perceiver architecture.
 
-The code borrows elements from the following repositories:
-https://github.com/lucidrains/perceiver-pytorch/blob/main/perceiver_pytorch/perceiver_pytorch.py
-https://github.com/mlfoundations/open_flamingo/blob/main/open_flamingo/src/helpers.py
+The code borrows elements from the following files:
+
+    https://github.com/lucidrains/perceiver-pytorch/blob/main/perceiver_pytorch/perceiver_pytorch.py
+    https://github.com/mlfoundations/open_flamingo/blob/main/open_flamingo/src/helpers.py
 """
 
 import torch

aurora/model/perceiver_decoder.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 from datetime import timedelta
 

aurora/model/perceiver_encoder.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 from datetime import timedelta
 

aurora/model/pos_encode.py

@@ -1,5 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license.
 
 TODO(Johannes): not sure what to do with the licensing, now all used functions have been newly
                 written by myself

aurora/model/swin_3d_block.py

@@ -1,9 +1,10 @@
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license.
+
+Code adapted from
+
+    https://github.com/microsoft/Swin-Transformer/blob/main/models/swin_transformer_v2.py
+
 """
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
-# --------------------------------------------------------
-# Code adapted from https://github.com/microsoft/Swin-Transformer/blob/main/models/swin_transformer_v2.py
-# --------------------------------------------------------
 
 import itertools
 from functools import lru_cache

aurora/model/swin_block.py

@@ -1,17 +1,10 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-
---------------------------------------------------------
-Swin Transformer V2
-Copyright (c) 2022 Microsoft
-Licensed under The MIT License [see LICENSE for details]
-Written by Ze Liu
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license.
 
 Code adapted from
 
   https://github.com/microsoft/Swin-Transformer/blob/main/models/swin_transformer_v2.py
 
---------------------------------------------------------
+which was written by Ze Liu.
 """
 
 from functools import lru_cache

aurora/model/vit_block.py

@@ -1,5 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license.
 
 Extends TIMM transformer block with compute and  memory efficient FlashAttention
 

tests/test_headers.py

@@ -1,6 +1,4 @@
-"""
-Copyright (c) Microsoft Corporation. Licensed under the MIT license.
-"""
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""
 
 from pathlib import Path
 
@@ -9,10 +7,7 @@
 SKIP_FILES: set[str] = {"_version.py"}
 """set[str]: These files are not required to have a copyright notice."""
 
-COPYRIGHT_NOTICE: list[str] = [
-    '"""',
-    "Copyright (c) Microsoft Corporation. Licensed under the MIT license.",
-]
+COPYRIGHT_NOTICE: str = '"""Copyright (c) Microsoft Corporation. Licensed under the MIT license.'
 
 
 @pytest.mark.parametrize("python_file", Path(__file__).parents[1].rglob("**/*.py"))
@@ -23,7 +18,5 @@ def test_presence_of_copyright_header(python_file: Path) -> None:
     with open(python_file) as f:
         lines = list(f.read().splitlines())
 
-    contains_notice = len(lines) >= len(COPYRIGHT_NOTICE)
-    contains_notice &= all(x.strip() == y.strip() for x, y in zip(lines, COPYRIGHT_NOTICE))
-    if not contains_notice:
+    if not lines or not lines[0].startswith(COPYRIGHT_NOTICE):
         raise AssertionError(f"`{python_file}` must start with the copyright notice.")

tests/test_model.py

@@ -0,0 +1 @@
+"""Copyright (c) Microsoft Corporation. Licensed under the MIT license."""