-
Notifications
You must be signed in to change notification settings - Fork 27.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Community Event] Docstring Sprint #26638
Comments
Hi @ydshieh !, I would like to work on this issue. Can you please assign me? From the list of OBJECTS_TO_IGNORE, I would like to work on "AlbertModel" |
Hi! I would like to work on 'BertGenerationConfig'. |
Hi @ydshieh !, |
Hi @ydshieh, i would like to work on this issue, could assign me 'BertModel'. |
I'll take DonutImageProcessor! |
Hi @ydshieh I can take care of |
ZeroShotObjectDetectionPipeline |
is this issue is open or closed? |
i would like to work on |
I will be working on |
i would like to work on |
I will be working on |
I'll work on Edit: Also working on |
Hi @ydshieh, I'd like to work on |
Interested in working on |
I would like to work on Update Oct 13: Also working on |
I am trying to install dependencies using
@ydshieh Could you please help me here. |
I am facing a similar problem i have referenced it here #26656 |
I am also facing a similar problem, also Mac with m1 chip. Referenced at #26666 |
When I ran
After this, I ran
Is second error caused because of first error? @ydshieh, @NielsRogge Could you please help me here. Sorry for asking many questions. I am new to transformers library and open source in general. |
Hei! I will work on CodeGen entries: |
Maybe try with a new fresh python environment, preferably with miniconda and with a python version 3.8.x |
I'll work on |
* [docstring] Remove 'BertGenerationConfig' from OBJECTS_TO_IGNORE * [docstring] Fix docstring for 'BertGenerationConfig' (huggingface#26638)
I will be working on LukeConfig, thanks! #26858 |
I will be working on |
@ydshieh can you please help:
|
what is your torch version? |
it's |
ChineseCLIPImageProcessor, ChineseCLIPTextConfig, ChineseCLIPVisionConfig |
I will take AltCLIPVisionConfig, AltCLIPTextConfig |
@ydshieh I ran make fixup
fatal: Not a valid object name main
Traceback (most recent call last):
File "/workspaces/transformers/utils/get_modified_files.py", line 27, in <module>
fork_point_sha = subprocess.check_output("git merge-base main HEAD".split()).decode("utf-8")
File "/usr/local/python/3.10.8/lib/python3.10/subprocess.py", line 421, in check_output
return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
File "/usr/local/python/3.10.8/lib/python3.10/subprocess.py", line 526, in run
raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['git', 'merge-base', 'main', 'HEAD']' returned non-zero exit status 128.
No library .py files were modified
python utils/custom_init_isort.py
python utils/sort_auto_mappings.py
doc-builder style src/transformers docs/source --max_len 119 --path_to_docs docs/source
python utils/check_doc_toc.py --fix_and_overwrite
running deps_table_update
updating src/transformers/dependency_versions_table.py
python utils/check_copies.py
python utils/check_table.py
python utils/check_dummies.py
python utils/check_repo.py
2023-10-18 20:17:59.925820: E tensorflow/compiler/xla/stream_executor/cuda/cuda_dnn.cc:9342] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered
2023-10-18 20:17:59.925873: E tensorflow/compiler/xla/stream_executor/cuda/cuda_fft.cc:609] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered
2023-10-18 20:17:59.925929: E tensorflow/compiler/xla/stream_executor/cuda/cuda_blas.cc:1518] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered
2023-10-18 20:18:00.934413: W tensorflow/compiler/tf2tensorrt/utils/py_utils.cc:38] TF-TRT Warning: Could not find TensorRT
Checking all models are included.
Checking all models are public.
Checking all models are properly tested.
Checking all objects are properly documented.
Checking all models are in at least one auto class.
Checking all names in auto name mappings are defined.
Checking all keys in auto name mappings are defined in `CONFIG_MAPPING_NAMES`.
Checking all auto mappings could be imported.
Checking all objects are equally (across frameworks) in the main __init__.
Using TensorFlow backend
/workspaces/transformers/src/transformers/deepspeed.py:23: FutureWarning: transformers.deepspeed module is deprecated and will be removed in a future version. Please import deepspeed modules directly from transformers.integrations
warnings.warn(
/workspaces/transformers/src/transformers/generation_flax_utils.py:24: FutureWarning: Importing `FlaxGenerationMixin` from `src/transformers/generation_flax_utils.py` is deprecated and will be removed in Transformers v5. Import as `from transformers import FlaxGenerationMixin` instead.
warnings.warn(
/workspaces/transformers/src/transformers/generation_tf_utils.py:24: FutureWarning: Importing `TFGenerationMixin` from `src/transformers/generation_tf_utils.py` is deprecated and will be removed in Transformers v5. Import as `from transformers import TFGenerationMixin` instead.
warnings.warn(
/workspaces/transformers/src/transformers/generation_utils.py:24: FutureWarning: Importing `GenerationMixin` from `src/transformers/generation_utils.py` is deprecated and will be removed in Transformers v5. Import as `from transformers import GenerationMixin` instead.
warnings.warn(
No GPU/TPU found, falling back to CPU. (Set TF_CPP_MIN_LOG_LEVEL=0 and rerun for more info.)
Checking the DEPRECATED_MODELS constant is up to date.
python utils/check_inits.py
python utils/check_config_docstrings.py
python utils/check_config_attributes.py
python utils/check_doctest_list.py
python utils/update_metadata.py --check-only
2023-10-18 20:18:17.099792: E tensorflow/compiler/xla/stream_executor/cuda/cuda_dnn.cc:9342] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered
2023-10-18 20:18:17.099854: E tensorflow/compiler/xla/stream_executor/cuda/cuda_fft.cc:609] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered
2023-10-18 20:18:17.099911: E tensorflow/compiler/xla/stream_executor/cuda/cuda_blas.cc:1518] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered
2023-10-18 20:18:18.165840: W tensorflow/compiler/tf2tensorrt/utils/py_utils.cc:38] TF-TRT Warning: Could not find TensorRT
python utils/check_task_guides.py
python utils/check_docstrings.py
2023-10-18 20:18:24.343502: E tensorflow/compiler/xla/stream_executor/cuda/cuda_dnn.cc:9342] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered
2023-10-18 20:18:24.343555: E tensorflow/compiler/xla/stream_executor/cuda/cuda_fft.cc:609] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered
2023-10-18 20:18:24.343613: E tensorflow/compiler/xla/stream_executor/cuda/cuda_blas.cc:1518] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered
2023-10-18 20:18:25.399133: W tensorflow/compiler/tf2tensorrt/utils/py_utils.cc:38] TF-TRT Warning: Could not find TensorRT
Traceback (most recent call last):
File "/workspaces/transformers/utils/check_docstrings.py", line 1238, in <module>
check_docstrings(overwrite=args.fix_and_overwrite)
File "/workspaces/transformers/utils/check_docstrings.py", line 1230, in check_docstrings
raise ValueError(error_message)
ValueError: There was at least one problem when checking docstrings of public objects.
The following objects docstrings do not match their signature. Run `make fix-copies` to fix this.
- TFRegNetForImageClassification
- TFRegNetModel
make: *** [Makefile:46: repo-consistency] Error 1 I would like to know if this is the expected output. These are the details after running - `transformers` version: 4.35.0.dev0
- Platform: Linux-6.2.0-1014-azure-x86_64-with-glibc2.31
- Python version: 3.10.8
- Huggingface_hub version: 0.17.3
- Safetensors version: 0.4.0
- Accelerate version: 0.23.0
- Accelerate config: not found
- PyTorch version (GPU?): 2.1.0+cu121 (False)
- Tensorflow version (GPU?): 2.14.0 (False)
- Flax version (CPU?/GPU?/TPU?): 0.7.0 (cpu)
- Jax version: 0.4.13
- JaxLib version: 0.4.13 I did run $ make fix-copies
python utils/check_copies.py --fix_and_overwrite
python utils/check_table.py --fix_and_overwrite
python utils/check_dummies.py --fix_and_overwrite
python utils/check_doctest_list.py --fix_and_overwrite
python utils/check_task_guides.py --fix_and_overwrite
python utils/check_docstrings.py --fix_and_overwrite
2023-10-18 20:56:23.959231: E tensorflow/compiler/xla/stream_executor/cuda/cuda_dnn.cc:9342] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered
2023-10-18 20:56:23.959590: E tensorflow/compiler/xla/stream_executor/cuda/cuda_fft.cc:609] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered
2023-10-18 20:56:23.959717: E tensorflow/compiler/xla/stream_executor/cuda/cuda_blas.cc:1518] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered
2023-10-18 20:56:24.963094: W tensorflow/compiler/tf2tensorrt/utils/py_utils.cc:38] TF-TRT Warning: Could not find TensorRT |
I guess you have Either having a new fresh python environment, or uninstall |
ErnieConfig, ErnieMConfig |
* [docstring] Remove 'BertGenerationConfig' from OBJECTS_TO_IGNORE * [docstring] Fix docstring for 'BertGenerationConfig' (huggingface#26638)
* [docstring] Remove 'BertGenerationConfig' from OBJECTS_TO_IGNORE * [docstring] Fix docstring for 'BertGenerationConfig' (huggingface#26638)
Docstring is important to understand what inputs a function/method expect and the output format it returns !
This issue is part of the HACKTOBERFEST event 🔥 . It is a call for contributions with the goal being to help
transformers
having the required and correct docstring, so users can use it more smoothly.Adding/Fixing a docstring is a simple (possibly first) contribution to Transformers and most importantly a very important contribution to the Transformers community ❤️ .
If you're interested in making a (maybe first!) contribution, please read through the Guide to contributing below. Before starting work on it, please reply in this thread which file you'd like to take :)
An example of such PR.
Guide to contributing:
pip install -e ".[dev]"
, as described in the contributor guidelines above, to ensure that the code quality tools inmake fixup
can run.utils/check_docstrings.py
:OBJECTS_TO_IGNORE =
OBJECTS_TO_IGNORE
(make sure it is not taken yet by someone in the comments of this issue)OBJECTS_TO_IGNORE
python3 utils/check_docstrings.py --fix_and_overwrite
<fill_type>
or<fill_docstring>
appear:you can usually find the content to fill from other files (by searching the codebase)
compared to step 5.), the output now looks like:
commit the changes
utils/check_docstrings.py
make fixup
[docstring] ... (entry name you work on) ...
Looking forward to your contributions 🔥 ❤️ 🚀 !
The text was updated successfully, but these errors were encountered: