π Geometric Computer Vision Library for Spatial AI
Python artificial-intelligencecomputer-visiondeep-learninghacktoberfestimage-processingmachine-learningneural-networkpythonpytorchroboticsspatial-ai
# LICENSE HEADER MANAGED BY add-license-header
#
# Copyright 2018 Kornia Team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import ast
import inspect
import re
import pytest
import kornia.augmentation as K
def _documented_args(cls):
doc = inspect.getdoc(cls) or ""
block = re.search(r"Args:\n(.*?)\n\s*(?:Shape|Returns?|Examples?|Inputs|Convention|\.\. note::|Note)", doc, re.S)
assert block, f"{cls.__name__} has no Args block"
return [match.group(1) for match in re.finditer(r"^\s{4}(\w+):", block.group(1), re.M)]
@pytest.mark.parametrize(
"cls",
[
K.ColorJitter,
K.ColorJiggle,
K.Denormalize,
K.RandomBrightness,
K.RandomCutMixV2,
K.RandomGaussianBlur,
K.RandomSnow,
K.RandomThinPlateSpline,
],
)
def test_args_block_matches_the_constructor(cls):
# kornia#4437: three classes documented a `silence_instantiation_warning` argument that does not
# exist, and ColorJitter did not document its real `order` argument.
# kornia#4496: RandomCutMixV2 documented nonexistent `height`/`width` and omitted `data_keys`;
# Denormalize and RandomThinPlateSpline had the same drift and were fixed before this pin.
signature = list(inspect.signature(cls.__init__).parameters)[1:]
assert sorted(_documented_args(cls)) == sorted(signature)
@pytest.mark.parametrize("cls", [K.RandomSnow])
def test_documented_defaults_match_the_constructor(cls):
# RandomSnow documented `p` as defaulting to 0.5 while the constructor default is 1.0.
doc = inspect.getdoc(cls) or ""
block = re.search(r"Args:\n(.*?)\n\s*(?:Shape|Returns?|Examples?|Inputs|Convention)", doc, re.S).group(1)
signature = inspect.signature(cls.__init__).parameters
documented = {
match.group(1): ast.literal_eval(match.group(2))
for match in re.finditer(r"^\s{4}(\w+):.*?Default: ([\w.]+)\.\s*$", block, re.M)
}
assert documented
assert documented == {name: signature[name].default for name in documented}