torch-linear-assignment 0.0.1__tar.gz

torch_linear_assignment-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

torch_linear_assignment-0.0.1/MANIFEST.in

@@ -0,0 +1,32 @@
+# Manifest syntax https://packaging.python.org/en/latest/guides/using-manifest-in/
+#graft wheelhouse
+
+recursive-exclude __pycache__  *.py[cod] *.orig
+recursive-include torch_linear_assignment *.py
+recursive-include src *.cpp
+
+# Include the README and CHANGELOG
+include *.md
+
+# Include the license file
+include LICENSE
+
+
+# exclude tests from package
+recursive-exclude tests *
+recursive-exclude site *
+exclude tests
+
+# Include the Requirements
+include requirements.txt
+
+# Exclude build configs
+exclude *.sh
+exclude *.toml
+exclude *.yml
+exclude *.yaml
+exclude Makefile
+
+prune .devcontainer
+prune .git
+prune .github

torch_linear_assignment-0.0.1/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: torch-linear-assignment
+Version: 0.0.1
+Summary: Batched linear assignment with PyTorch and CUDA.
+Author: Ivan Karpukhin
+Author-email: karpuhini@yandex.ru
+License-File: LICENSE
+Requires-Dist: torch>=1.12.0
+Requires-Dist: scipy>=1.6.0

torch_linear_assignment-0.0.1/README.md

@@ -0,0 +1,73 @@
+# Batch linear assignment for PyTorch
+<h4 align="left">
+    <p>
+        <a href="#Install">Installation</a> |
+        <a href="#Example">Usage</a> |
+        <a href="#Citation">Citation</a>
+    <p>
+</h4>
+Batch computation of the linear assignment problem on GPU.
+
+## Install
+Build and install package:
+```bash
+pip install .
+```
+
+When building with CUDA, make sure NVCC has the same CUDA version as PyTorch.
+You can choose CUDA version by
+```bash
+export PATH=/usr/local/cuda-<version>/bin:"$PATH"
+```
+
+If you need custom C++ compiler, use the following command:
+```bash
+CXX=<c++-compiler> CC=<gcc-compiler> pip install .
+```
+
+If you get a torch-not-found error, try the following command:
+```bash
+pip install --upgrade pip wheel setuptools
+python -m pip install .
+```
+
+## Example
+```python
+import torch
+from torch_linear_assignment import batch_linear_assignment
+
+cost = torch.tensor([
+    8, 4, 7,
+    5, 2, 3,
+    9, 6, 7,
+    9, 4, 8
+]).reshape(1, 4, 3).cuda()
+
+assignment = batch_linear_assignment(cost)
+print(assignment)
+```
+
+The output is:
+```py
+tensor([[ 0,  2, -1,  1]], device='cuda:0')
+```
+
+# Citation
+The code was originally developed for the [HoTPP Benchmark](https://github.com/ivan-chai/hotpp-benchmark). If you use this code in your research project, please cite one of the following papers:
+```
+@article{karpukhin2024hotppbenchmark,
+  title={HoTPP Benchmark: Are We Good at the Long Horizon Events Forecasting?},
+  author={Karpukhin, Ivan and Shipilov, Foma and Savchenko, Andrey},
+  journal={arXiv preprint arXiv:2406.14341},
+  year={2024},
+  url ={https://arxiv.org/abs/2406.14341}
+}
+
+@article{karpukhin2024detpp,
+  title={DeTPP: Leveraging Object Detection for Robust Long-Horizon Event Prediction},
+  author={Karpukhin, Ivan and Savchenko, Andrey},
+  journal={arXiv preprint arXiv:2408.13131},
+  year={2024},
+  url ={https://arxiv.org/abs/2408.13131}
+}
+```

torch_linear_assignment-0.0.1/requirements.txt

@@ -0,0 +1,2 @@
+torch >= 1.12.0
+scipy >= 1.6.0

torch_linear_assignment-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

torch_linear_assignment-0.0.1/setup.py

@@ -0,0 +1,68 @@
+import os
+from setuptools import setup
+
+
+with open("requirements.txt", "r") as fp:
+    required_packages = [line.strip() for line in fp.readlines()]
+
+
+def is_cuda() -> bool:
+    import torch
+
+    return torch.backends.cuda.is_built() and int(os.environ.get("TLA_BUILD_CUDA", "1")) and torch.cuda.is_available()
+
+
+def generate_cuda_ext_modules() -> list:
+    import torch.utils.cpp_extension as torch_cpp_ext
+
+    compile_args = {
+        "cxx": ["-O3"]
+    }
+    if os.environ.get("CC", None) is not None:
+        compile_args["nvcc"] = ["-ccbin", os.environ["CC"]]
+    return [
+        torch_cpp_ext.CUDAExtension(
+            "torch_linear_assignment._backend",
+            [
+                "src/torch_linear_assignment_cuda.cpp",
+                "src/torch_linear_assignment_cuda_kernel.cu"
+            ],
+            extra_compile_args=compile_args
+        )
+    ]
+
+
+def generate_cpu_ext_modules() -> list:
+    import torch.utils.cpp_extension as torch_cpp_ext
+
+    return [
+        torch_cpp_ext.CppExtension(
+            "torch_linear_assignment._backend",
+            [
+                "src/torch_linear_assignment.cpp",
+            ],
+            extra_compile_args={"cxx": ["-O3"]}
+        )
+    ]
+
+def get_build_ext():
+    import torch.utils.cpp_extension as torch_cpp_ext
+
+    return torch_cpp_ext.BuildExtension
+
+
+if __name__ == '__main__':
+    setup(
+        name="torch-linear-assignment",
+        version="0.0.1",
+        author="Ivan Karpukhin",
+        author_email="karpuhini@yandex.ru",
+        description="Batched linear assignment with PyTorch and CUDA.",
+        packages=["torch_linear_assignment"],
+        ext_modules=generate_cuda_ext_modules() if is_cuda() else generate_cpu_ext_modules(),
+        setup_requires=required_packages,
+        install_requires=required_packages,
+        cmdclass={
+            "build_ext": get_build_ext()
+        }
+    )

torch_linear_assignment-0.0.1/src/torch_linear_assignment.cpp

@@ -0,0 +1,9 @@
+#include <torch/extension.h>
+
+bool has_cuda() {
+  return false;
+}
+
+PYBIND11_MODULE(TORCH_EXTENSION_NAME, m) {
+  m.def("has_cuda", &has_cuda, "CUDA build flag.");
+}

torch_linear_assignment-0.0.1/src/torch_linear_assignment_cuda.cpp

@@ -0,0 +1,22 @@
+#include <torch/extension.h>
+
+std::vector<torch::Tensor> batch_linear_assignment_cuda(torch::Tensor cost);
+
+#define CHECK_CUDA(x) TORCH_CHECK(x.device().is_cuda(), #x " must be a CUDA tensor")
+#define CHECK_CONTIGUOUS(x) TORCH_CHECK(x.is_contiguous(), #x " must be contiguous")
+#define CHECK_INPUT(x) CHECK_CUDA(x); CHECK_CONTIGUOUS(x)
+
+// Returns col4row and row4col.
+std::vector<torch::Tensor> batch_linear_assignment(torch::Tensor cost) {
+  CHECK_INPUT(cost);
+  return batch_linear_assignment_cuda(cost);
+}
+
+bool has_cuda() {
+  return true;
+}
+
+PYBIND11_MODULE(TORCH_EXTENSION_NAME, m) {
+  m.def("has_cuda", &has_cuda, "CUDA build flag.");
+  m.def("batch_linear_assignment", &batch_linear_assignment, "Batch linear assignment (CUDA).");
+}

torch_linear_assignment-0.0.1/torch_linear_assignment/__init__.py

@@ -0,0 +1 @@
+from .assignment import batch_linear_assignment, assignment_to_indices

torch_linear_assignment-0.0.1/torch_linear_assignment/assignment.py

@@ -0,0 +1,78 @@
+import torch
+
+import torch_linear_assignment._backend as backend
+from scipy.optimize import linear_sum_assignment
+
+
+def batch_linear_assignment_cpu(cost):
+    b, w, t = cost.shape
+    matching = torch.full([b, w], -1, dtype=torch.long, device=cost.device)
+    for i in range(b):
+        workers, tasks = linear_sum_assignment(cost[i].numpy(), maximize=False)  # (N, 2).
+        workers = torch.from_numpy(workers)
+        tasks = torch.from_numpy(tasks)
+        matching[i].scatter_(0, workers, tasks)
+    return matching
+
+
+def batch_linear_assignment_cuda(cost):
+    b, w, t = cost.shape
+
+    if not isinstance(cost, (torch.FloatTensor, torch.DoubleTensor)):
+        cost = cost.to(torch.float)
+
+    if t < w:
+        cost = cost.transpose(1, 2)  # (B, T, W).
+        col4row, row4col = backend.batch_linear_assignment(cost.contiguous())  # (B, T), (B, W).
+        return row4col.long()
+    else:
+        col4row, row4col = backend.batch_linear_assignment(cost.contiguous())  # (B, W), (B, T).
+        return col4row.long()
+
+
+def batch_linear_assignment(cost):
+    """Solve a batch of linear assignment problems.
+
+    The method minimizes the cost.
+
+    Args:
+      cost: Cost matrix with shape (B, W, T), where W is the number of workers
+            and T is the number of tasks.
+
+    Returns:
+      Matching tensor with shape (B, W), with assignments for each worker. If the
+      task was not assigned, the corresponding index will be -1.
+    """
+    if cost.ndim != 3:
+        raise ValueError("Need 3-dimensional tensor with shape (B, W, T).")
+    if backend.has_cuda() and cost.is_cuda:
+        return batch_linear_assignment_cuda(cost)
+    else:
+        return batch_linear_assignment_cpu(cost)
+
+
+def assignment_to_indices(assignment):
+    """Convert assignment to the SciPy format.
+
+    Args:
+        assignment: The assignment with shape (B, W).
+
+    Returns:
+        row_ind, col_ind: An array of row indices and one of corresponding column indices
+            giving the optimal assignment, each with shape (B, K).
+
+    Raises:
+        ValueError if batch assignments have different sizes.
+    """
+    batch_size = assignment.shape[0]
+    if batch_size == 0:
+        indices = torch.zeros(0, 0, dtype=torch.long, device=assignment.device)
+        return indices, indices
+    mask = assignment >= 0
+    n_matches = mask.sum(1)
+    if (n_matches[1:] != n_matches[0]).any():
+        raise ValueError("Inconsistent matching sizes.")
+    n_matches = n_matches[0].item()
+    row_ind = mask.nonzero()[:, 1].reshape(batch_size, n_matches)
+    col_ind = assignment.masked_select(mask).reshape(batch_size, n_matches)
+    return row_ind, col_ind

torch_linear_assignment-0.0.1/torch_linear_assignment.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: torch-linear-assignment
+Version: 0.0.1
+Summary: Batched linear assignment with PyTorch and CUDA.
+Author: Ivan Karpukhin
+Author-email: karpuhini@yandex.ru
+License-File: LICENSE
+Requires-Dist: torch>=1.12.0
+Requires-Dist: scipy>=1.6.0

torch_linear_assignment-0.0.1/torch_linear_assignment.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+requirements.txt
+setup.py
+src/torch_linear_assignment.cpp
+src/torch_linear_assignment_cuda.cpp
+torch_linear_assignment/__init__.py
+torch_linear_assignment/assignment.py
+torch_linear_assignment.egg-info/PKG-INFO
+torch_linear_assignment.egg-info/SOURCES.txt
+torch_linear_assignment.egg-info/dependency_links.txt
+torch_linear_assignment.egg-info/requires.txt
+torch_linear_assignment.egg-info/top_level.txt

torch_linear_assignment-0.0.1/torch_linear_assignment.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

torch_linear_assignment-0.0.1/torch_linear_assignment.egg-info/requires.txt

@@ -0,0 +1,2 @@
+torch>=1.12.0
+scipy>=1.6.0

torch_linear_assignment-0.0.1/torch_linear_assignment.egg-info/top_level.txt

@@ -0,0 +1 @@
+torch_linear_assignment