mirror of
https://github.com/huggingface/transformers.git
synced 2025-07-03 12:50:06 +06:00
03af4c42a6
* Fix number of minimal calls to the Hub with peft integration * Alternate design * And this way? * Revert * Nits to fix * Add util * Print when changes are made * Add list to ignore * Add more rules * Manual fixes * deal with kwargs * deal with enum defaults * avoid many digits for floats * Manual fixes * Fix regex * Fix regex * Auto fix * Style * Apply script * Add ignored list * Add check that templates are filled * Adding to CI checks * Add back semi-fix * Ignore more objects * More auto-fixes * Ignore missing objects * Remove temp semi-fix * Fixes * Update src/transformers/models/pvt/configuration_pvt.py Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> * Update utils/check_docstrings.py Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> * Update src/transformers/utils/quantization_config.py Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> * Deal with float defaults * Fix small defaults * Address review comment * Treat * Post-rebase cleanup * Address review comment * Update src/transformers/models/deprecated/mctct/configuration_mctct.py Co-authored-by: Lysandre Debut <lysandre.debut@reseau.eseo.fr> * Address review comment --------- Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> Co-authored-by: Lysandre Debut <lysandre.debut@reseau.eseo.fr>
99 lines
4.9 KiB
Python
99 lines
4.9 KiB
Python
# Copyright 2023 The HuggingFace Team. All rights reserved.
|
|
#
|
|
# 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 inspect
|
|
import os
|
|
import sys
|
|
import unittest
|
|
|
|
|
|
git_repo_path = os.path.abspath(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
|
|
sys.path.append(os.path.join(git_repo_path, "utils"))
|
|
|
|
from check_docstrings import get_default_description, replace_default_in_arg_description # noqa: E402
|
|
|
|
|
|
class CheckDostringsTested(unittest.TestCase):
|
|
def test_replace_default_in_arg_description(self):
|
|
# Standard docstring with default.
|
|
desc_with_default = "`float`, *optional*, defaults to 2.0"
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default, 2.0), "`float`, *optional*, defaults to 2.0"
|
|
)
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default, 1.0), "`float`, *optional*, defaults to 1.0"
|
|
)
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_default, inspect._empty), "`float`")
|
|
|
|
# Standard docstring with default but optional is not using the stars.
|
|
desc_with_default_typo = "`float`, `optional`, defaults to 2.0"
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default_typo, 2.0), "`float`, *optional*, defaults to 2.0"
|
|
)
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default_typo, 1.0), "`float`, *optional*, defaults to 1.0"
|
|
)
|
|
|
|
# If the default is None we do not erase the value in the docstring.
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default, None), "`float`, *optional*, defaults to 2.0"
|
|
)
|
|
# If the default is None (and set as such in the docstring), we do not include it.
|
|
desc_with_default = "`float`, *optional*, defaults to None"
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_default, None), "`float`, *optional*")
|
|
desc_with_default = "`float`, *optional*, defaults to `None`"
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_default, None), "`float`, *optional*")
|
|
|
|
# Operations are not replaced, but put in backtiks.
|
|
desc_with_default = "`float`, *optional*, defaults to 1/255"
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default, 1 / 255), "`float`, *optional*, defaults to `1/255`"
|
|
)
|
|
desc_with_default = "`float`, *optional*, defaults to `1/255`"
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_default, 1 / 255), "`float`, *optional*, defaults to `1/255`"
|
|
)
|
|
|
|
desc_with_optional = "`float`, *optional*"
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_optional, 2.0), "`float`, *optional*, defaults to 2.0"
|
|
)
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_optional, 1.0), "`float`, *optional*, defaults to 1.0"
|
|
)
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_optional, None), "`float`, *optional*")
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_optional, inspect._empty), "`float`")
|
|
|
|
desc_with_no_optional = "`float`"
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_no_optional, 2.0), "`float`, *optional*, defaults to 2.0"
|
|
)
|
|
self.assertEqual(
|
|
replace_default_in_arg_description(desc_with_no_optional, 1.0), "`float`, *optional*, defaults to 1.0"
|
|
)
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_no_optional, None), "`float`, *optional*")
|
|
self.assertEqual(replace_default_in_arg_description(desc_with_no_optional, inspect._empty), "`float`")
|
|
|
|
def test_get_default_description(self):
|
|
# Fake function to have arguments to test.
|
|
def _fake_function(a, b: int, c=1, d: float = 2.0, e: str = "blob"):
|
|
pass
|
|
|
|
params = inspect.signature(_fake_function).parameters
|
|
assert get_default_description(params["a"]) == "`<fill_type>`"
|
|
assert get_default_description(params["b"]) == "`int`"
|
|
assert get_default_description(params["c"]) == "`<fill_type>`, *optional*, defaults to 1"
|
|
assert get_default_description(params["d"]) == "`float`, *optional*, defaults to 2.0"
|
|
assert get_default_description(params["e"]) == '`str`, *optional*, defaults to `"blob"`'
|