Add api info for torch._C._nn.pyi

[FFFrog]

Stack from ghstack (oldest at bottom):

• -> Add api info for torch._C._nn.pyi #148405

APis involved are as followed:

• adaptive_avg_pool2d
• adaptive_avg_pool3d
• binary_cross_entropy
• col2im

ISSUE Related:
#148404

[pytorch-bot]

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/148405

• 📄 Preview Python docs built from this PR
• 📄 Preview C++ docs built from this PR
• ❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

❌ 2 Cancelled Jobs

As of commit 0c301b9 with merge base 56b03df ():

CANCELLED JOBS - The following jobs were cancelled. Please retry:

• trunk / linux-jammy-rocm-py3.10 / test (default, 1, 2, linux.rocm.gpu.2) (gh)
• trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.2) (gh)

This comment was automatically generated by Dr. CI and updates every 15 minutes.

[zou3519]

Honestly speaking I don't know what this PR does or what the linked issue is trying to do. Could you explain more please?

[FFFrog]

Of course, @zou3519

As shown below:

pytorch/torch/nn/functional.py

Lines 1370 to 1382 in 2e7c9d3

	def adaptive_avg_pool2d(input: Tensor, output_size: BroadcastingList2[int]) -> Tensor:
	r"""Apply a 2D adaptive average pooling over an input signal composed of several input planes.
	See :class:`~torch.nn.AdaptiveAvgPool2d` for details and output shape.
	Args:
	output_size: the target output size (single integer or
	double-integer tuple)
	"""
	if has_torch_function_unary(input):
	return handle_torch_function(adaptive_avg_pool2d, (input,), input, output_size)
	_output_size = _list_with_default(output_size, input.size())
	return torch._C._nn.adaptive_avg_pool2d(input, _output_size)

torch._C._nn.adaptive_avg_pool2d provides the basic functionality of torch.nn. functional.adaptive_avg_pool2d, but lacks code hints for torch._C._nn.adaptive_avg_pool2d. Similar to _C.__init__.pyi, we need to add code hints for _C._nn._pyi. Since part of _nn.pyi is automatically generated by codegen, I made some changes to tools/pyi/gen_pyi.py.

[zou3519]

Can we add tests for this?

[FFFrog]

Can we add tests for this?

Yes, in theory, we can add tests for this.

However, this test is a little special: we cannot write test cases for it directly, but can only write scripts to dynamically filter specific attributes in torch._C._nn and compare them with the pre-made entries in tools/pyi/gen_pyi.py to see if there are any missing ones.

If you think the above solution is feasible, then I can complete this test case together with the final PR that fills in these code hints.

[FFFrog]

Hey @zou3519，
Could you help to check it again? Thank you.

[FFFrog]

Hey @zou3519，could you help to check it again?

[ezyang]

@pytorchbot merge

[pytorchmergebot]

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

[pytorchmergebot]

Merge failed

Reason: 3 jobs have failed, first few of them are: linux-binary-manywheel / manywheel-py3_9-cuda11_8-build / build, linux-binary-manywheel / manywheel-py3_9-cuda12_6-build / build, linux-binary-libtorch-cxx11-abi / libtorch-cpu-shared-with-deps-cxx11-abi-build / build

Details for Dev Infra team

Raised by workflow job

[ezyang]

@pytorchbot merge -r

[pytorchmergebot]

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

[pytorchmergebot]

Successfully rebased gh/fffrog/49/orig onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via ghstack checkout https://github.com/pytorch/pytorch/pull/148405)

[pytorchmergebot]

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

[pytorchmergebot]

Merge failed

Reason: 2 mandatory check(s) failed. The first few are:

• pull / linux-jammy-py3.13-clang12 / test (default, 3, 5, linux.4xlarge)
• Lint / lintrunner-noclang / linux-job

Dig deeper by viewing the failures on hud

Details for Dev Infra team

Raised by workflow job

Failing merge rule: Core Maintainers

[FFFrog]

@pytorchbot merge

[pytorchmergebot]

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

[pytorchmergebot]

Merge failed

Reason: 2 jobs have failed, first few of them are: trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.2), trunk / linux-jammy-rocm-py3.10 / test (default, 1, 2, linux.rocm.gpu.2)

Details for Dev Infra team

Raised by workflow job

[FFFrog]

@pytorchbot merge

[pytorchmergebot]

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

[pytorchmergebot]

Merge failed

Reason: 2 jobs have failed, first few of them are: trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.2), trunk / linux-jammy-rocm-py3.10 / test (default, 1, 2, linux.rocm.gpu.2)

Details for Dev Infra team

Raised by workflow job

[FFFrog]

@pytorchbot merge -i

[pytorchmergebot]

Merge started

Your change will be merged while ignoring the following 2 checks: trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.2), trunk / linux-jammy-rocm-py3.10 / test (default, 1, 2, linux.rocm.gpu.2)

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here