mirror of
https://github.com/saymrwulf/pytorch.git
synced 2026-05-15 21:00:47 +00:00
ef6ea545e8
Summary: This PR adds Python/C++ API parity tracker at `test/cpp_api_parity/parity-tracker.md`, which currently shows parity status for `torch.nn` modules. A good amount of line changes here is moving `new_criterion_tests` from `test_nn.py` to `common_nn.py`, so that it can be used in `test_cpp_api_parity.py`. Pull Request resolved: https://github.com/pytorch/pytorch/pull/25289 Differential Revision: D17188085 Pulled By: yf225 fbshipit-source-id: 33d12fb1a4de2d9147ed09380973f361a3981fdf
79 lines
2.4 KiB
Python
79 lines
2.4 KiB
Python
from collections import namedtuple
|
|
|
|
TorchNNTestParams = namedtuple(
|
|
'TorchNNTestParams',
|
|
[
|
|
'module_name',
|
|
'module_variant_name',
|
|
'python_constructor_args',
|
|
'cpp_constructor_args',
|
|
'example_inputs',
|
|
'has_parity',
|
|
'python_module_class',
|
|
'cpp_sources',
|
|
'num_attrs_recursive',
|
|
'device',
|
|
]
|
|
)
|
|
|
|
CppArg = namedtuple('CppArg', ['type', 'value'])
|
|
|
|
ParityStatus = namedtuple('ParityStatus', ['has_impl_parity', 'has_doc_parity'])
|
|
|
|
TorchNNModuleMetadata = namedtuple('TorchNNModuleMetadata', ['cpp_default_constructor_args', 'num_attrs_recursive', 'cpp_sources'])
|
|
TorchNNModuleMetadata.__new__.__defaults__ = (None, None, '')
|
|
|
|
'''
|
|
This function expects the parity tracker Markdown file to have the following format:
|
|
|
|
```
|
|
## package1_name
|
|
|
|
API | Implementation Parity | Doc Parity
|
|
------------- | ------------- | -------------
|
|
API_Name|No|No
|
|
...
|
|
|
|
## package2_name
|
|
|
|
API | Implementation Parity | Doc Parity
|
|
------------- | ------------- | -------------
|
|
API_Name|No|No
|
|
...
|
|
```
|
|
|
|
The returned dict has the following format:
|
|
|
|
```
|
|
Dict[package_name]
|
|
-> Dict[api_name]
|
|
-> ParityStatus
|
|
```
|
|
'''
|
|
def parse_parity_tracker_table(file_path):
|
|
def parse_parity_choice(str):
|
|
if str in ['Yes', 'No']:
|
|
return str == 'Yes'
|
|
else:
|
|
raise RuntimeError(
|
|
'{} is not a supported parity choice. The valid choices are "Yes" and "No".'.format(str))
|
|
|
|
parity_tracker_dict = {}
|
|
|
|
with open(file_path, 'r') as f:
|
|
all_text = f.read()
|
|
packages = all_text.split('##')
|
|
for package in packages[1:]:
|
|
lines = [line.strip() for line in package.split('\n') if line.strip() != '']
|
|
package_name = lines[0]
|
|
if package_name in parity_tracker_dict:
|
|
raise RuntimeError("Duplicated package name `{}` found in {}".format(package_name, file_path))
|
|
else:
|
|
parity_tracker_dict[package_name] = {}
|
|
for api_status in lines[3:]:
|
|
api_name, has_impl_parity_str, has_doc_parity_str = [x.strip() for x in api_status.split('|')]
|
|
parity_tracker_dict[package_name][api_name] = ParityStatus(
|
|
has_impl_parity=parse_parity_choice(has_impl_parity_str),
|
|
has_doc_parity=parse_parity_choice(has_doc_parity_str))
|
|
|
|
return parity_tracker_dict
|