pytorch/test
Edward Z. Yang 2f7cfecd86 Complete revamp of float/promotion sympy handling (#126905)
At a high level, the idea behind this PR is:

* Make it clearer what the promotion and int/float rules for various Sympy operations are. Operators that previously were polymorphic over int/float are now split into separate operators for clarity. We never do mixed int/float addition/multiplication etc in sympy, instead, we always promote to the appropriate operator. (However, equality is currently not done correctly.)
* Enforce strict typing on ValueRanges: if you have a ValueRange for a float, the lower and upper MUST be floats, and so forth for integers.

The story begins in **torch/utils/_sympy/functions.py**. Here, I make some changes to how we represent certain operations in sympy expressions:

* FloorDiv now only supports integer inputs; to do float floor division, do a truediv and then a trunc. Additionally, we remove the divide out addition by gcd optimization, because sympy gcd is over fields and is willing to generate rationals (but rationals are bad for ValueRange strict typing).
* ModularIndexing, LShift, RShift now assert they are given integer inputs.
* Mod only supports integer inputs; eventually we will support FloatMod (left for later work, when we build out Sympy support for floating operations). Unfortunately, I couldn't assert integer inputs here, because of a bad interaction with sympy's inequality solver that is used by the offline solver
* TrueDiv is split into FloatTrueDiv and IntTrueDiv. This allows for us to eventually generate accurate code for Python semantics IntTrueDiv, which is written in a special way to preserve precision when the inputs are >= 2**53 beyond what first coercing the integer to floats and then doing true division.
* Trunc is split to TruncToFloat and TruncToInt.
* Round is updated to return a float, not an int, making it consistent with the round op handler in Inductor. To get Python-style conversion to int, we call TruncToInt on the result.
* RoundDecimal updated to consistently only ever return a float
* Add ToFloat for explicit coercion to float (required so we can enforce strict ValueRanges typing)

In **torch/__init__.py**, we modify SymInt and SymFloat to appropriately call into new bindings that route to these refined sympy operations.  Also, we modify `torch.sym_min` and `torch.sym_max` to have promotion semantics (if one argument is a float, the return result is always a float), making them inconsistent with builtins.min/max, but possible to do type analysis without runtime information.

We also need to introduce some new op handlers in **torch/_inductor/ops_handler.py**:

* `to_int` for truncation to int64, directly corresponding to TruncToInt; this can be implemented by trunc and dtype, but with a dedicated handler it is more convenient for roundtripping in Sympy
* `int_truediv` for Python-style integer true division, which has higher precision than casting to floats and then running `truediv`

These changes have consequences. First, we need to make some administrative changes:

* Actually wire up these Sympy functions from SymInt/SymFloat in **torch/fx/experimental/sym_node.py**, including the new promotion rules (promote2)
* Add support for new Sympy functions in **torch/utils/_sympy/interp.py**, **torch/utils/_sympy/reference.py**
  * In particular, in torch.utils._sympy.reference, we have a strong preference to NOT do nontrivial compute, instead, everything in ops handler should map to a singular sympy function
  * TODO: I chose to roundtrip mod back to our Mod function, but I think I'm going to have to deal with the C/Python inconsistency this to fix tests here
* Add printer support for the Sympy functions in **torch/_inductor/codegen/common.py**, **torch/_inductor/codegen/cpp_utils.py**, **torch/_inductor/codegen/triton.py**. `int_truediv` and mixed precision equality is currently not implemented soundly, so we will lose precision in codegen for large values. TODO: The additions here are not exhaustive yet
* Update ValueRanges logic to use new sympy functions in **torch/utils/_sympy/value_ranges.py**. In general, we prefer to use the new Sympy function rather than try to roll things by hand, which is what was done previously for many VR analysis functions.

In **torch/fx/experimental/symbolic_shapes.py** we need to make some symbolic reasoning adjustments:

* Avoid generation of rational subexpressions by removing simplification of `x // y` into `floor(x / y)`. This simplification then triggers an addition simplification rule `(x + y) / c --> x / c + y / c` which is bad because x / c is a rational number now
* `_assert_bound_is_rational` is no more, we no longer generate rational bounds
* Don't intersect non-int value ranges with the `int_range`
* Support more sympy Functions for guard SYMPY_INTERP
* Assert the type of value range is consistent with the variable type

The new asserts uncovered necessary bug fixes:

* **torch/_inductor/codegen/cpp.py**, **torch/_inductor/select_algorithm.py**, **torch/_inductor/sizevars.py** - Ensure Wild/Symbol manually allocated in Inductor is marked `is_integer` so it's accepted to build expressions
* **torch/_inductor/utils.py** - make sure you actually pass in sympy.Expr to these functions
* **torch/_inductor/ir.py** - make_contiguous_strides_for takes int/SymInt, not sympy.Expr!
* **torch/export/dynamic_shapes.py** - don't use infinity to represent int ranges, instead use sys.maxsize - 1

Because of the removal of some symbolic reasoning that produced rationals, some of our symbolic reasoning has gotten worse and we are unable to simplify some guards. Check the TODO at **test/test_proxy_tensor.py**

Signed-off-by: Edward Z. Yang <ezyang@meta.com>

Pull Request resolved: https://github.com/pytorch/pytorch/pull/126905
Approved by: https://github.com/xadupre, https://github.com/lezcano
2024-06-06 02:29:45 +00:00
..
ao/sparsity
autograd
backends/xeon
benchmark_utils
bottleneck_test
cpp Remove unused functions (#127881) 2024-06-05 05:21:24 +00:00
cpp_api_parity
cpp_extensions Support torch.dtype as parameter in pybind11 cpp extension. (#126865) 2024-05-29 23:19:32 +00:00
custom_backend [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
custom_operator [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
distributed WorkerServer: add support for binding to TCP (#127986) 2024-06-05 22:56:32 +00:00
distributions [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
dynamo Complete revamp of float/promotion sympy handling (#126905) 2024-06-06 02:29:45 +00:00
dynamo_expected_failures [dynamo][numpy] Add unsigned integer dtypes (#125717) 2024-06-05 14:33:47 +00:00
dynamo_skips [dynamo] Graph break on set_num_threads (#126623) 2024-05-20 17:44:32 +00:00
edge [BE][CMake] Use FindPython module (#124613) 2024-05-29 13:17:35 +00:00
error_messages
expect Lift jagged -> padded dense forward / backward kernels from fbgemm_gpu (#125946) 2024-06-03 23:41:54 +00:00
export Handle unpacking during TorchScript to ExportedProgram conversion (#127419) 2024-06-05 15:27:13 +00:00
forward_backward_compatibility [SDPA/memeff] Backport changes from xFormers to PT (#127090) 2024-06-05 07:33:27 +00:00
functorch [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
fx Implement Graph Transform Observer (#127427) 2024-06-02 06:49:47 +00:00
higher_order_ops [torchbind] Add inductor support (#123709) 2024-05-13 18:18:17 +00:00
inductor Complete revamp of float/promotion sympy handling (#126905) 2024-06-06 02:29:45 +00:00
jit [reland] Refresh OpOverloadPacket if a new OpOverload gets added (#128000) 2024-06-05 17:57:09 +00:00
jit_hooks
lazy [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
mobile [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
nn [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
onnx Complete revamp of float/promotion sympy handling (#126905) 2024-06-06 02:29:45 +00:00
onnx_caffe2 [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
optim Quick Fix on #126854, deepcopy lr and other possible base_parameters (#127190) 2024-06-03 18:06:31 +00:00
package [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
profiler [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
quantization [CUDNN] Remove defunct cuDNN V8 API build flag (#120006) 2024-06-03 22:42:05 +00:00
scripts [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_img
torch_np [dynamo] Support ndarray.dtype attribute access (#124490) 2024-06-05 17:20:01 +00:00
typing [1/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort stdlib (#127122) 2024-05-25 08:25:50 +00:00
xpu
_test_bazel.py
allowlist_for_publicAPI.json Revert "Retire torch.distributed.pipeline (#127354)" 2024-06-04 18:19:31 +00:00
conftest.py
create_dummy_torchscript_model.py
delete.py
hi.py
HowToWriteTestsUsingFileCheck.md
linear.py
load_torchscript_model.py
minioptest_failures_dict.json
mkl_verbose.py
mkldnn_verbose.py
pytest_shard_custom.py
run_doctests.sh
run_test.py [CI] disable td for xpu ci test by default (#127611) 2024-06-04 17:15:10 +00:00
simulate_nccl_errors.py
test_ao_sparsity.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_autocast.py [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
test_autograd.py [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
test_autograd_fallback.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_binary_ufuncs.py [dynamo] Support ndarray.dtype attribute access (#124490) 2024-06-05 17:20:01 +00:00
test_bundled_images.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_bundled_inputs.py
test_ci_sanity_check_fail.py
test_comparison_utils.py
test_compile_benchmark_util.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_complex.py
test_content_store.py
test_cpp_api_parity.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_cpp_extensions_aot.py Support torch.dtype as parameter in pybind11 cpp extension. (#126865) 2024-05-29 23:19:32 +00:00
test_cpp_extensions_jit.py
test_cpp_extensions_mtia_backend.py
test_cpp_extensions_open_device_registration.py Fix map_location for wrapper subclass and device tensors that go through numpy (#126728) 2024-05-24 16:39:30 +00:00
test_cpp_extensions_stream_and_event.py
test_cuda.py [BE][Eazy] remove torch.torch.xxx usages (#127800) 2024-06-05 21:53:49 +00:00
test_cuda_expandable_segments.py
test_cuda_multigpu.py Deprecate device-specific GradScaler autocast API (#126527) 2024-05-25 06:41:34 +00:00
test_cuda_nvml_based_avail.py
test_cuda_primary_ctx.py
test_cuda_sanitizer.py
test_cuda_trace.py
test_custom_ops.py [reland] Refresh OpOverloadPacket if a new OpOverload gets added (#128000) 2024-06-05 17:57:09 +00:00
test_dataloader.py
test_datapipe.py [BE][Ez]: Apply PYI059 - Generic always come last (#127685) 2024-06-02 13:38:58 +00:00
test_decomp.py [decomp] Fix default values missing from inplace rrelu decomposition (#126978) 2024-05-26 23:49:40 +00:00
test_deploy.py
test_determination.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_dispatch.py
test_dlpack.py
test_dynamic_shapes.py Complete revamp of float/promotion sympy handling (#126905) 2024-06-06 02:29:45 +00:00
test_expanded_weights.py
test_fake_tensor.py [fake tensor] Set _is_param for base fake tensors for views (#127823) 2024-06-05 20:26:52 +00:00
test_flop_counter.py Foward fix lint after #125747 (#126295) 2024-05-15 16:37:48 +00:00
test_foreach.py Allow slow foreach to run for any backend, not just CPU (#127412) 2024-06-01 13:58:18 +00:00
test_function_schema.py Enable UFMT on test/test_fake_tensor.py, test/test_flop_counter.py and some files (#125747) 2024-05-15 14:50:14 +00:00
test_functional_autograd_benchmark.py Enable UFMT on test/test_fake_tensor.py, test/test_flop_counter.py and some files (#125747) 2024-05-15 14:50:14 +00:00
test_functional_optim.py Enable UFMT on test/test_fake_tensor.py, test/test_flop_counter.py and some files (#125747) 2024-05-15 14:50:14 +00:00
test_functionalization.py
test_functionalization_of_rng_ops.py Enable UFMT on test/test_fake_tensor.py, test/test_flop_counter.py and some files (#125747) 2024-05-15 14:50:14 +00:00
test_futures.py
test_fx.py Remove removed ruff rule TRY200 (#126256) 2024-05-17 16:31:05 +00:00
test_fx_experimental.py Revert "Add aten._unsafe_masked_index (#116491)" 2024-06-03 15:51:50 +00:00
test_fx_passes.py
test_fx_reinplace_pass.py
test_hub.py Enable UFMT on test/test_hub.py (#127155) 2024-05-25 18:23:24 +00:00
test_import_stats.py
test_indexing.py [dynamo] wrap GraphModule exceptions in dynamo-wrapped tests (#126341) 2024-05-29 05:18:04 +00:00
test_itt.py
test_jit.py [BE] enable ruff rule Q from flake8-quotes (#127713) 2024-06-02 23:25:26 +00:00
test_jit_autocast.py
test_jit_disabled.py
test_jit_fuser.py
test_jit_fuser_legacy.py
test_jit_fuser_te.py Enable UFMT on test/test_jit_fuser_te.py (#127759) 2024-06-04 16:56:03 +00:00
test_jit_legacy.py
test_jit_llga_fuser.py [BE]: Update ruff to v0.4.4 (#125031) 2024-05-12 20:02:37 +00:00
test_jit_profiling.py
test_jit_simple.py
test_jit_string.py
test_jiterator.py
test_kernel_launch_checks.py
test_legacy_vmap.py
test_license.py Enable UFMT format on test/license.py test/logging.py (#125737) 2024-05-11 01:52:35 +00:00
test_linalg.py [ROCm] TunableOp improvements (#124362) 2024-06-03 22:30:11 +00:00
test_logging.py Enable UFMT format on test/license.py test/logging.py (#125737) 2024-05-11 01:52:35 +00:00
test_masked.py
test_maskedtensor.py
test_matmul_cuda.py FP8 rowwise scaling (#125204) 2024-06-05 15:46:40 +00:00
test_meta.py Correct error message for aten::_local_scalar_dense on meta tensor (#124554) 2024-05-30 00:50:29 +00:00
test_metal.py
test_mkl_verbose.py
test_mkldnn.py [dynamo] wrap GraphModule exceptions in dynamo-wrapped tests (#126341) 2024-05-29 05:18:04 +00:00
test_mkldnn_fusion.py
test_mkldnn_verbose.py
test_mobile_optimizer.py [BE] enable ruff rule Q from flake8-quotes (#127713) 2024-06-02 23:25:26 +00:00
test_model_dump.py
test_model_exports_to_core_aten.py
test_module_tracker.py [dynamo] wrap GraphModule exceptions in dynamo-wrapped tests (#126341) 2024-05-29 05:18:04 +00:00
test_modules.py Revert "Default meta device to use swap_tensors in nn.Module._apply (.to_empty and .to('meta')) (#126819)" 2024-06-01 18:46:16 +00:00
test_monitor.py
test_mps.py Restore MPS testing on MacOS 13 and m2 metal (#127853) 2024-06-05 14:44:00 +00:00
test_multiprocessing.py
test_multiprocessing_spawn.py
test_namedtensor.py
test_namedtuple_return_api.py
test_native_functions.py
test_native_mha.py
test_nestedtensor.py [NestedTensor] Add error checks for unbind operator coverage when ragged_idx != 1 (#128058) 2024-06-06 01:56:12 +00:00
test_nn.py Default XLA to use swap_tensors path in nn.Module._apply (#126814) 2024-06-04 21:40:49 +00:00
test_nnapi.py Enable ufmt format on test files (#126845) 2024-05-28 01:42:07 +00:00
test_numba_integration.py Enable ufmt format on test files (#126845) 2024-05-28 01:42:07 +00:00
test_numpy_interop.py [dynamo][numpy] Add unsigned integer dtypes (#125717) 2024-06-05 14:33:47 +00:00
test_openmp.py Enable ufmt format on test files (#126845) 2024-05-28 01:42:07 +00:00
test_ops.py Add fake impl for aten.unique_dim (#126561) 2024-06-01 04:03:10 +00:00
test_ops_fwd_gradients.py
test_ops_gradients.py
test_ops_jit.py
test_optim.py Revert "[BE] wrap deprecated function/class with typing_extensions.deprecated (#126898)" 2024-05-31 19:47:24 +00:00
test_out_dtype_op.py
test_overrides.py Properly detect nested torch function args (#127496) 2024-06-02 03:43:22 +00:00
test_package.py
test_per_overload_api.py
test_prims.py [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
test_proxy_tensor.py Complete revamp of float/promotion sympy handling (#126905) 2024-06-06 02:29:45 +00:00
test_pruning_op.py
test_public_bindings.py Revert "Retire torch.distributed.pipeline (#127354)" 2024-06-04 18:19:31 +00:00
test_python_dispatch.py [BE]: Update ruff to v0.4.4 (#125031) 2024-05-12 20:02:37 +00:00
test_pytree.py [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
test_quantization.py
test_reductions.py Remove calls of deprecated _aminmax (#127182) 2024-05-28 03:51:45 +00:00
test_scatter_gather_ops.py
test_schema_check.py [dynamo] wrap GraphModule exceptions in dynamo-wrapped tests (#126341) 2024-05-29 05:18:04 +00:00
test_segment_reductions.py
test_serialization.py Remove tensor subclass detection logic from weights_only unpickler (#127808) 2024-06-05 02:14:30 +00:00
test_set_default_mobile_cpu_allocator.py
test_shape_ops.py Enable UFMT on test_shape_ops.py test_show_pickle.py test_sort_and_select.py (#127165) 2024-06-05 14:31:26 +00:00
test_show_pickle.py Enable UFMT on test_shape_ops.py test_show_pickle.py test_sort_and_select.py (#127165) 2024-06-05 14:31:26 +00:00
test_sort_and_select.py Enable UFMT on test_shape_ops.py test_show_pickle.py test_sort_and_select.py (#127165) 2024-06-05 14:31:26 +00:00
test_sparse.py [traced-graph][sparse] propagate sparsity metadata into traced graph (#117907) 2024-05-23 22:46:46 +00:00
test_sparse_csr.py
test_sparse_semi_structured.py
test_spectral_ops.py
test_stateless.py [BE] wrap deprecated function/class with typing_extensions.deprecated (#127689) 2024-06-02 12:30:43 +00:00
test_static_runtime.py [BE] enable ruff rule Q from flake8-quotes (#127713) 2024-06-02 23:25:26 +00:00
test_subclass.py
test_sympy_utils.py Complete revamp of float/promotion sympy handling (#126905) 2024-06-06 02:29:45 +00:00
test_tensor_creation_ops.py [dynamo] wrap GraphModule exceptions in dynamo-wrapped tests (#126341) 2024-05-29 05:18:04 +00:00
test_tensorboard.py
test_tensorexpr.py
test_tensorexpr_pybind.py
test_testing.py Revert "Retire torch.distributed.pipeline (#127354)" 2024-06-04 18:19:31 +00:00
test_throughput_benchmark.py Enable UFMT format on test/test_throughput_benchmark.py test/test_type_hints.py test/test_type_info.py (#125906) 2024-05-11 04:32:01 +00:00
test_torch.py [BE]: Apply PLR1736 fixes (unnecessary index lookup) (#127716) 2024-06-03 17:22:13 +00:00
test_transformers.py
test_type_hints.py Enable UFMT format on test/test_throughput_benchmark.py test/test_type_hints.py test/test_type_info.py (#125906) 2024-05-11 04:32:01 +00:00
test_type_info.py Enable UFMT format on test/test_throughput_benchmark.py test/test_type_hints.py test/test_type_info.py (#125906) 2024-05-11 04:32:01 +00:00
test_type_promotion.py [dynamo] wrap GraphModule exceptions in dynamo-wrapped tests (#126341) 2024-05-29 05:18:04 +00:00
test_typing.py
test_unary_ufuncs.py [dynamo] Support ndarray.dtype attribute access (#124490) 2024-06-05 17:20:01 +00:00
test_utils.py Enable UFMT format on test/test_utils.py (#125996) 2024-05-15 18:22:57 +00:00
test_view_ops.py [5/N][Easy] fix typo for usort config in pyproject.toml (kown -> known): sort torch (#127126) 2024-05-27 14:49:57 +00:00
test_vulkan.py
test_weak.py
test_xnnpack_integration.py
test_xpu.py xpu: implement xpu serialization (#125530) 2024-05-16 20:22:17 +00:00