1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
|
// ----------------------------------------------------------------------------
// - Open3D: www.open3d.org -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
#include "open3d/core/Tensor.h"
#include <vector>
#include "open3d/core/Blob.h"
#include "open3d/core/CUDAUtils.h"
#include "open3d/core/Device.h"
#include "open3d/core/Dispatch.h"
#include "open3d/core/Dtype.h"
#include "open3d/core/Scalar.h"
#include "open3d/core/SizeVector.h"
#include "open3d/core/TensorKey.h"
#include "open3d/utility/Optional.h"
#include "pybind/core/core.h"
#include "pybind/core/tensor_converter.h"
#include "pybind/core/tensor_type_caster.h"
#include "pybind/docstring.h"
#include "pybind/open3d_pybind.h"
#include "pybind/pybind_utils.h"
#define CONST_ARG const
#define NON_CONST_ARG
#define BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(py_name, cpp_name, self_const) \
tensor.def(#py_name, [](self_const Tensor& self, const Tensor& other) { \
return self.cpp_name(other); \
}); \
tensor.def(#py_name, [](Tensor& self, float value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, double value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, int8_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, int16_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, int32_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, int64_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, uint8_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, uint16_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, uint32_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, uint64_t value) { \
return self.cpp_name(Scalar(value)); \
}); \
tensor.def(#py_name, [](Tensor& self, bool value) { \
return self.cpp_name(Scalar(value)); \
});
#define BIND_CLIP_SCALAR(py_name, cpp_name, self_const) \
tensor.def(#py_name, \
[](self_const Tensor& self, float min_v, float max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, double min_v, double max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, int8_t min_v, int8_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, int16_t min_v, int16_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, int32_t min_v, int32_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, int64_t min_v, int64_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, uint8_t min_v, uint8_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, uint16_t min_v, uint16_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, uint32_t min_v, uint32_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, \
[](self_const Tensor& self, uint64_t min_v, uint64_t max_v) { \
return self.cpp_name(min_v, max_v); \
}); \
tensor.def(#py_name, [](self_const Tensor& self, bool min_v, bool max_v) { \
return self.cpp_name(min_v, max_v); \
});
#define BIND_BINARY_R_OP_ALL_DTYPES(py_name, cpp_name) \
tensor.def(#py_name, [](const Tensor& self, float value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, double value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, int8_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, int16_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, int32_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, int64_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, uint8_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, uint16_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, uint32_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, uint64_t value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
}); \
tensor.def(#py_name, [](const Tensor& self, bool value) { \
return Tensor::Full({}, value, self.GetDtype(), self.GetDevice()) \
.cpp_name(self); \
});
#define BIND_REDUCTION_OP(py_name, cpp_name) \
tensor.def( \
#py_name, \
[](const Tensor& tensor, const utility::optional<SizeVector>& dim, \
bool keepdim) { \
SizeVector reduction_dims; \
if (dim.has_value()) { \
reduction_dims = dim.value(); \
} else { \
for (int64_t i = 0; i < tensor.NumDims(); i++) { \
reduction_dims.push_back(i); \
} \
} \
return tensor.cpp_name(reduction_dims, keepdim); \
}, \
"dim"_a = py::none(), "keepdim"_a = false);
// TODO (rishabh): add this behavior to the cpp implementation. Refer to the
// Tensor::Any and Tensor::All ops.
#define BIND_REDUCTION_OP_NO_KEEPDIM(py_name, cpp_name) \
tensor.def( \
#py_name, \
[](const Tensor& tensor, \
const utility::optional<SizeVector>& dim) { \
SizeVector reduction_dims; \
if (dim.has_value()) { \
reduction_dims = dim.value(); \
} else { \
for (int64_t i = 0; i < tensor.NumDims(); i++) { \
reduction_dims.push_back(i); \
} \
} \
return tensor.cpp_name(reduction_dims); \
}, \
"dim"_a = py::none());
namespace open3d {
namespace core {
const std::unordered_map<std::string, std::string> argument_docs = {
{"dtype", "Data type for the Tensor."},
{"device", "Compute device to store and operate on the Tensor."},
{"shape", "List of Tensor dimensions."},
{"fill_value", "Scalar value to initialize all elements with."},
{"scalar_value", "Initial value for the single element tensor."},
{"copy",
"If true, a new tensor is always created; if false, the copy is "
"avoided when the original tensor already has the targeted dtype."}};
template <typename T>
static std::vector<T> ToFlatVector(
py::array_t<T, py::array::c_style | py::array::forcecast> np_array) {
py::buffer_info info = np_array.request();
T* start = static_cast<T*>(info.ptr);
return std::vector<T>(start, start + info.size);
}
template <typename func_t>
static void BindTensorCreation(py::module& m,
py::class_<Tensor>& tensor,
const std::string& py_name,
func_t cpp_func) {
tensor.def_static(
py_name.c_str(),
[cpp_func](const SizeVector& shape, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return cpp_func(
shape,
dtype.has_value() ? dtype.value() : core::Float32,
device.has_value() ? device.value() : Device("CPU:0"));
},
"Create Tensor with a given shape.", "shape"_a,
"dtype"_a = py::none(), "device"_a = py::none());
docstring::ClassMethodDocInject(m, "Tensor", py_name, argument_docs);
}
template <typename T>
static void BindTensorFullCreation(py::module& m, py::class_<Tensor>& tensor) {
tensor.def_static(
"full",
[](const SizeVector& shape, T fill_value,
utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return Tensor::Full<T>(
shape, fill_value,
dtype.has_value() ? dtype.value() : core::Float32,
device.has_value() ? device.value() : Device("CPU:0"));
},
"shape"_a, "fill_value"_a, "dtype"_a = py::none(),
"device"_a = py::none());
}
void pybind_core_tensor_declarations(py::module& m) {
py::class_<Tensor> tensor(
m, "Tensor",
"A Tensor is a view of a data Blob with shape, stride, data_ptr.");
m.attr("capsule") = py::module_::import("typing").attr("Any");
}
void pybind_core_tensor_definitions(py::module& m) {
auto tensor = static_cast<py::class_<Tensor>>(m.attr("Tensor"));
// o3c.Tensor(np.array([[0, 1, 2], [3, 4, 5]]), dtype=None, device=None).
tensor.def(py::init([](const py::array& np_array,
utility::optional<Dtype> dtype,
utility::optional<Device> device) {
Tensor t = PyArrayToTensor(np_array, /*inplace=*/false);
if (dtype.has_value()) {
t = t.To(dtype.value());
}
if (device.has_value()) {
t = t.To(device.value());
}
return t;
}),
"Initialize Tensor from a Numpy array.", "np_array"_a,
"dtype"_a = py::none(), "device"_a = py::none());
// o3c.Tensor(True, dtype=None, device=None).
// Default to Bool, CPU:0.
tensor.def(py::init([](bool scalar_value, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return BoolToTensor(scalar_value, dtype, device);
}),
"scalar_value"_a, "dtype"_a = py::none(),
"device"_a = py::none());
// o3c.Tensor(1, dtype=None, device=None).
// Default to Int64, CPU:0.
tensor.def(py::init([](int64_t scalar_value, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return IntToTensor(scalar_value, dtype, device);
}),
"scalar_value"_a, "dtype"_a = py::none(),
"device"_a = py::none());
// o3c.Tensor(3.14, dtype=None, device=None).
// Default to Float64, CPU:0.
tensor.def(py::init([](double scalar_value, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return DoubleToTensor(scalar_value, dtype, device);
}),
"scalar_value"_a, "dtype"_a = py::none(),
"device"_a = py::none());
// o3c.Tensor([[0, 1, 2], [3, 4, 5]], dtype=None, device=None).
tensor.def(
py::init([](const py::list& shape, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return PyListToTensor(shape, dtype, device);
}),
"Initialize Tensor from a nested list.", "shape"_a,
"dtype"_a = py::none(), "device"_a = py::none());
// o3c.Tensor(((0, 1, 2), (3, 4, 5)), dtype=None, device=None).
tensor.def(
py::init([](const py::tuple& shape, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return PyTupleToTensor(shape, dtype, device);
}),
"Initialize Tensor from a nested tuple.", "shape"_a,
"dtype"_a = py::none(), "device"_a = py::none());
docstring::ClassMethodDocInject(m, "Tensor", "__init__", argument_docs);
pybind_core_tensor_accessor(tensor);
// Tensor creation API.
BindTensorCreation(m, tensor, "empty", Tensor::Empty);
BindTensorCreation(m, tensor, "zeros", Tensor::Zeros);
BindTensorCreation(m, tensor, "ones", Tensor::Ones);
BindTensorFullCreation<float>(m, tensor);
BindTensorFullCreation<double>(m, tensor);
BindTensorFullCreation<int8_t>(m, tensor);
BindTensorFullCreation<int16_t>(m, tensor);
BindTensorFullCreation<int32_t>(m, tensor);
BindTensorFullCreation<int64_t>(m, tensor);
BindTensorFullCreation<uint8_t>(m, tensor);
BindTensorFullCreation<uint16_t>(m, tensor);
BindTensorFullCreation<uint32_t>(m, tensor);
BindTensorFullCreation<uint64_t>(m, tensor);
BindTensorFullCreation<bool>(m, tensor);
docstring::ClassMethodDocInject(m, "Tensor", "full", argument_docs);
// Pickling support.
// The tensor will be on the same device after deserialization.
// Non contiguous tensors will be converted to contiguous tensors after
// deserialization.
tensor.def(py::pickle(
[](const Tensor& t) {
// __getstate__
return py::make_tuple(t.GetDevice(),
TensorToPyArray(t.To(Device("CPU:0"))));
},
[](py::tuple t) {
// __setstate__
if (t.size() != 2) {
utility::LogError(
"Cannot unpickle Tensor! Expecting a tuple of size "
"2.");
}
const Device& device = t[0].cast<Device>();
if (!device.IsAvailable()) {
utility::LogWarning(
"Device {} is not available, tensor will be "
"created on CPU.",
device.ToString());
return PyArrayToTensor(t[1].cast<py::array>(), true);
} else {
return PyArrayToTensor(t[1].cast<py::array>(), true)
.To(device);
}
}));
tensor.def_static(
"eye",
[](int64_t n, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return Tensor::Eye(
n, dtype.has_value() ? dtype.value() : core::Float32,
device.has_value() ? device.value() : Device("CPU:0"));
},
"Create an identity matrix of size n x n.", "n"_a,
"dtype"_a = py::none(), "device"_a = py::none());
tensor.def_static("diag", &Tensor::Diag);
// Tensor creation from arange for int.
tensor.def_static(
"arange",
[](int64_t stop, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return Tensor::Arange(
0, stop, 1,
dtype.has_value() ? dtype.value() : core::Int64,
device.has_value() ? device.value() : Device("CPU:0"));
},
"Create a 1D tensor with evenly spaced values in the given "
"interval.",
"stop"_a, py::pos_only(), py::kw_only(), "dtype"_a = py::none(),
"device"_a = py::none());
tensor.def_static(
"arange",
[](int64_t start, int64_t stop, utility::optional<int64_t> step,
utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return Tensor::Arange(
start, stop, step.has_value() ? step.value() : 1,
dtype.has_value() ? dtype.value() : core::Int64,
device.has_value() ? device.value() : Device("CPU:0"));
},
"Create a 1D tensor with evenly spaced values in the given "
"interval.",
"start"_a, "stop"_a, "step"_a = py::none(), "dtype"_a = py::none(),
py::kw_only(), "device"_a = py::none());
// Tensor creation from arange for float.
tensor.def_static(
"arange",
[](double stop, utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return Tensor::Arange(
0.0, stop, 1.0,
dtype.has_value() ? dtype.value() : core::Float64,
device.has_value() ? device.value() : Device("CPU:0"));
},
"Create a 1D tensor with evenly spaced values in the given "
"interval.",
"stop"_a, py::pos_only(), py::kw_only(), "dtype"_a = py::none(),
"device"_a = py::none());
tensor.def_static(
"arange",
[](double start, double stop, utility::optional<double> step,
utility::optional<Dtype> dtype,
utility::optional<Device> device) {
return Tensor::Arange(
start, stop, step.has_value() ? step.value() : 1.0,
dtype.has_value() ? dtype.value() : core::Float64,
device.has_value() ? device.value() : Device("CPU:0"));
},
"Create a 1D tensor with evenly spaced values in the given "
"interval.",
"start"_a, "stop"_a, "step"_a = py::none(), "dtype"_a = py::none(),
py::kw_only(), "device"_a = py::none());
tensor.def(
"append",
[](const Tensor& tensor, const Tensor& values,
const utility::optional<int64_t> axis) {
if (axis.has_value()) {
return tensor.Append(values, axis);
}
return tensor.Append(values);
},
R"(Appends the `values` tensor, along the given axis and returns
a copy of the original tensor. Both the tensors must have same data-type
device, and number of dimensions. All dimensions must be the same, except the
dimension along the axis the tensors are to be appended.
This is the similar to NumPy's semantics:
- https://numpy.org/doc/stable/reference/generated/numpy.append.html
Returns:
A copy of the tensor with `values` appended to axis. Note that append
does not occur in-place: a new array is allocated and filled. If axis
is None, out is a flattened tensor.
Example:
>>> a = o3d.core.Tensor([[0, 1], [2, 3]])
>>> b = o3d.core.Tensor([[4, 5]])
>>> a.append(b, axis = 0)
[[0 1],
[2 3],
[4 5]]
Tensor[shape={3, 2}, stride={2, 1}, Int64, CPU:0, 0x55555abc6b00]
>>> a.append(b)
[0 1 2 3 4 5]
Tensor[shape={6}, stride={1}, Int64, CPU:0, 0x55555abc6b70])",
"values"_a, "axis"_a = py::none());
// Device transfer.
tensor.def(
"cpu",
[](const Tensor& tensor) {
return tensor.To(core::Device("CPU:0"));
},
"Transfer the tensor to CPU. If the tensor "
"is already on CPU, no copy will be performed.");
tensor.def(
"cuda",
[](const Tensor& tensor, int device_id) {
return tensor.To(core::Device("CUDA", device_id));
},
"Transfer the tensor to a CUDA device. If the tensor is already "
"on the specified CUDA device, no copy will be performed.",
"device_id"_a = 0);
// Buffer I/O for Numpy and DLPack(PyTorch).
tensor.def("numpy", &core::TensorToPyArray);
tensor.def_static("from_numpy", [](py::array np_array) {
return core::PyArrayToTensor(np_array, /*inplace=*/true);
});
tensor.def("to_dlpack", [](const Tensor& tensor) {
DLManagedTensor* dl_managed_tensor = tensor.ToDLPack();
// See PyTorch's torch/csrc/Module.cpp
auto capsule_destructor = [](PyObject* data) {
DLManagedTensor* dl_managed_tensor =
(DLManagedTensor*)PyCapsule_GetPointer(data, "dltensor");
if (dl_managed_tensor) {
// the dl_managed_tensor has not been consumed,
// call deleter ourselves
dl_managed_tensor->deleter(
const_cast<DLManagedTensor*>(dl_managed_tensor));
} else {
// The dl_managed_tensor has been consumed
// PyCapsule_GetPointer has set an error indicator
PyErr_Clear();
}
};
return py::capsule(dl_managed_tensor, "dltensor", capsule_destructor);
});
tensor.def_static("from_dlpack", [](py::capsule data) {
DLManagedTensor* dl_managed_tensor =
static_cast<DLManagedTensor*>(data);
if (!dl_managed_tensor) {
utility::LogError(
"from_dlpack must receive "
"DLManagedTensor PyCapsule.");
}
// Make sure that the PyCapsule is not used again.
// See:
// torch/csrc/Module.cpp, and
// https://github.com/cupy/cupy/pull/1445/files#diff-ddf01ff512087ef616db57ecab88c6ae
Tensor t = Tensor::FromDLPack(dl_managed_tensor);
PyCapsule_SetName(data.ptr(), "used_dltensor");
return t;
});
// Numpy IO.
tensor.def("save", &Tensor::Save, "Save tensor to Numpy's npy format.",
"file_name"_a);
tensor.def_static("load", &Tensor::Load,
"Load tensor from Numpy's npy format.", "file_name"_a);
/// Linalg operations.
tensor.def("det", &Tensor::Det,
"Compute the determinant of a 2D square tensor.");
tensor.def(
"lu_ipiv", &Tensor::LUIpiv,
R"(Computes LU factorisation of the 2D square tensor, using A = P * L * U;
where P is the permutation matrix, L is the lower-triangular matrix with
diagonal elements as 1.0 and U is the upper-triangular matrix, and returns
tuple `output` tensor of shape {n,n} and `ipiv` tensor of shape {n}, where
{n,n} is the shape of input tensor.
Returns:
ipiv: ipiv is a 1D integer pivot indices tensor. It contains the pivot
indices, indicating row i of the matrix was interchanged with row
ipiv[i]
output: It has L as lower triangular values and U as upper triangle
values including the main diagonal (diagonal elements of L to be
taken as unity).
Example:
>>> ipiv, output = a.lu_ipiv())");
tensor.def("matmul", &Tensor::Matmul,
"Computes matrix multiplication of a"
" 2D tensor with another tensor of compatible shape.");
tensor.def("__matmul__", &Tensor::Matmul,
"Computes matrix multiplication of a"
" 2D tensor with another tensor of compatible shape.");
tensor.def("lstsq", &Tensor::LeastSquares,
"Solves the linear system AX = B with QR decomposition and "
"returns X. A is a (m, n) matrix with m >= n.",
"B"_a);
tensor.def("solve", &Tensor::Solve,
"Solves the linear system AX = B with LU decomposition and "
"returns X. A must be a square matrix.",
"B"_a);
tensor.def("inv", &Tensor::Inverse,
"Computes the matrix inverse of the square matrix self with "
"LU factorization and returns the result.");
tensor.def("svd", &Tensor::SVD,
"Computes the matrix SVD decomposition :math:`A = U S V^T` and "
"returns "
"the result. Note :math:`V^T` (V transpose) is returned "
"instead of :math:`V`.");
tensor.def("triu", &Tensor::Triu,
"Returns the upper triangular matrix of the 2D tensor, above "
"the given diagonal index. [The value of diagonal = col - row, "
"therefore 0 is the main diagonal (row = col), and it shifts "
"towards right for positive values (for diagonal = 1, col - row "
"= 1), and towards left for negative values. The value of the "
"diagonal parameter must be between [-m, n] for a {m,n} shaped "
"tensor.",
"diagonal"_a = 0);
docstring::ClassMethodDocInject(m, "Tensor", "triu",
{{"diagonal",
"Value of [col - row], above which the "
"elements are to be taken for"
" upper triangular matrix."}});
tensor.def("tril", &Tensor::Tril,
"Returns the lower triangular matrix of the 2D tensor, above "
"the given diagonal index. [The value of diagonal = col - row, "
"therefore 0 is the main diagonal (row = col), and it shifts "
"towards right for positive values (for diagonal = 1, col - row "
"= 1), and towards left for negative values. The value of the "
"diagonal parameter must be between [-m, n] where {m, n} is the "
"shape of input tensor.",
"diagonal"_a = 0);
docstring::ClassMethodDocInject(
m, "Tensor", "tril",
{{"diagonal",
"Value of [col - row], below which the elements are to be taken "
"for lower triangular matrix."}});
tensor.def(
"triul", &Tensor::Triul,
"Returns the tuple of upper and lower triangular matrix of the 2D "
"tensor, above and below the given diagonal index. The diagonal "
"elements of lower triangular matrix are taken to be unity. [The "
"value of diagonal = col - row, therefore 0 is the main diagonal "
"(row = col), and it shifts towards right for positive values (for "
"diagonal = 1, col - row = 1), and towards left for negative "
"values. The value of the diagonal parameter must be between [-m, "
"n] where {m, n} is the shape of input tensor.",
"diagonal"_a = 0);
docstring::ClassMethodDocInject(
m, "Tensor", "triul",
{{"diagonal",
"Value of [col - row], above and below which the elements are to "
"be taken for upper (diag. included) and lower triangular "
"matrix."}});
tensor.def(
"lu",
[](const Tensor& tensor, bool permute_l) {
return tensor.LU(permute_l);
},
"permute_l"_a = false,
R"(Computes LU factorisation of the 2D square tensor, using A = P * L * U;
where P is the permutation matrix, L is the lower-triangular matrix with
diagonal elements as 1.0 and U is the upper-triangular matrix, and returns
tuple (P, L, U).
Returns:
Tuple (P, L, U).)");
docstring::ClassMethodDocInject(
m, "Tensor", "lu", {{"permute_l", "If True, returns L as P * L."}});
// Casting and copying.
tensor.def(
"to",
[](const Tensor& tensor, Dtype dtype, bool copy) {
return tensor.To(dtype, copy);
},
"Returns a tensor with the specified ``dtype``.", "dtype"_a,
"copy"_a = false);
tensor.def(
"to",
[](const Tensor& tensor, const Device& device, bool copy) {
return tensor.To(device, copy);
},
"Returns a tensor with the specified ``device``.", "device"_a,
"copy"_a = false);
tensor.def(
"to",
[](const Tensor& tensor, const Device& device, Dtype dtype,
bool copy) { return tensor.To(device, dtype, copy); },
"Returns a tensor with the specified ``device`` and ``dtype``."
"device"_a,
"dtype"_a, "copy"_a = false);
docstring::ClassMethodDocInject(m, "Tensor", "to", argument_docs);
tensor.def("clone", &Tensor::Clone, "Copy Tensor to the same device.");
tensor.def("T", &Tensor::T,
"Transpose <=2-D tensor by swapping dimension 0 and 1."
"0-D and 1-D Tensor remains the same.");
tensor.def(
"reshape", &Tensor::Reshape,
R"(Returns a tensor with the same data and number of elements as input, but
with the specified shape. When possible, the returned tensor will be a view of
input. Otherwise, it will be a copy.
Contiguous inputs and inputs with compatible strides can be reshaped
without copying, but you should not depend on the copying vs. viewing
behavior.
Ref:
- https://pytorch.org/docs/stable/tensors.html
- aten/src/ATen/native/TensorShape.cpp
- aten/src/ATen/TensorUtils.cpp)",
"dst_shape"_a);
docstring::ClassMethodDocInject(m, "Tensor", "reshape",
{{"dst_shape",
"Compatible destination shape with the "
"same number of elements."}});
tensor.def("contiguous", &Tensor::Contiguous,
"Returns a contiguous tensor containing the same data in the "
"same device. If the tensor is already contiguous, the same "
"underlying memory will be used.");
tensor.def("is_contiguous", &Tensor::IsContiguous,
"Returns True if the underlying memory buffer is contiguous.");
tensor.def(
"flatten", &Tensor::Flatten,
R"(Flattens input by reshaping it into a one-dimensional tensor. If
start_dim or end_dim are passed, only dimensions starting with start_dim
and ending with end_dim are flattened. The order of elements in input is
unchanged.
Unlike NumPy’s flatten, which always copies input’s data, this function
may return the original object, a view, or copy. If no dimensions are
flattened, then the original object input is returned. Otherwise, if
input can be viewed as the flattened shape, then that view is returned.
Finally, only if the input cannot be viewed as the flattened shape is
input’s data copied.
Ref:
- https://pytorch.org/docs/stable/tensors.html
- aten/src/ATen/native/TensorShape.cpp
- aten/src/ATen/TensorUtils.cpp)",
"start_dim"_a = 0, "end_dim"_a = -1);
docstring::ClassMethodDocInject(
m, "Tensor", "flatten",
{{"start_dim", "The first dimension to flatten (inclusive)."},
{"end_dim",
"The last dimension to flatten, starting from start_dim "
"(inclusive)."}});
// See "emulating numeric types" section for Python built-in numeric ops.
// https://docs.python.org/3/reference/datamodel.html#emulating-numeric-types
//
// BinaryEW: add.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(add, Add, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(add_, Add_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__add__, Add, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__iadd__, Add_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__radd__, Add);
// BinaryEW: sub.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(sub, Sub, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(sub_, Sub_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__sub__, Sub, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__isub__, Sub_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rsub__, Sub);
// BinaryEW: mul.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(mul, Mul, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(mul_, Mul_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__mul__, Mul, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__imul__, Mul_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rmul__, Mul);
// BinaryEW: div.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(div, Div, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(div_, Div_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__div__, Div, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__idiv__, Div_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rdiv__, Div);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__truediv__, Div, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__itruediv__, Div_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rtruediv__, Div);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__floordiv__, Div,
CONST_ARG); // truediv only.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__ifloordiv__, Div_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rfloordiv__, Div);
// BinaryEW: and.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(logical_and, LogicalAnd, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(logical_and_, LogicalAnd_,
NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__and__, LogicalAnd, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__iand__, LogicalAnd_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rand__, LogicalAnd);
// BinaryEW: or.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(logical_or, LogicalOr, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(logical_or_, LogicalOr_,
NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__or__, LogicalOr, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__ior__, LogicalOr_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__ror__, LogicalOr);
// BinaryEW: xor.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(logical_xor, LogicalXor, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(logical_xor_, LogicalXor_,
NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__xor__, LogicalXor, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__ixor__, LogicalXor_, NON_CONST_ARG);
BIND_BINARY_R_OP_ALL_DTYPES(__rxor__, LogicalXor);
// BinaryEW: comparison ops.
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(gt, Gt, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(gt_, Gt_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__gt__, Gt, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(lt, Lt, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(lt_, Lt_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__lt__, Lt, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(ge, Ge, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(ge_, Ge_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__ge__, Ge, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(le, Le, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(le_, Le_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__le__, Le, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(eq, Eq, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(eq_, Eq_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__eq__, Eq, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(ne, Ne, CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(ne_, Ne_, NON_CONST_ARG);
BIND_BINARY_OP_ALL_DTYPES_WITH_SCALAR(__ne__, Ne, CONST_ARG);
// Getters and setters as properties.
tensor.def_property_readonly(
"shape", [](const Tensor& tensor) { return tensor.GetShape(); });
tensor.def_property_readonly("strides", [](const Tensor& tensor) {
return tensor.GetStrides();
});
tensor.def_property_readonly("dtype", &Tensor::GetDtype);
tensor.def_property_readonly("blob", &Tensor::GetBlob);
tensor.def_property_readonly("ndim", &Tensor::NumDims);
tensor.def("num_elements", &Tensor::NumElements);
tensor.def("__bool__", &Tensor::IsNonZero); // Python 3.X.
tensor.def_property_readonly("device", &Tensor::GetDevice);
tensor.def_property_readonly("is_cpu", &Tensor::IsCPU);
tensor.def_property_readonly("is_cuda", &Tensor::IsCUDA);
// Length and iterator.
tensor.def("__len__", &Tensor::GetLength);
tensor.def(
"__iter__",
[](Tensor& tensor) {
return py::make_iterator(tensor.begin(), tensor.end());
},
py::keep_alive<0, 1>()); // Keep object alive while iterator exists
// Unary element-wise ops.
tensor.def("sqrt", &Tensor::Sqrt);
tensor.def("sqrt_", &Tensor::Sqrt_);
tensor.def("sin", &Tensor::Sin);
tensor.def("sin_", &Tensor::Sin_);
tensor.def("cos", &Tensor::Cos);
tensor.def("cos_", &Tensor::Cos_);
tensor.def("neg", &Tensor::Neg);
tensor.def("neg_", &Tensor::Neg_);
tensor.def("__neg__", &Tensor::Neg);
tensor.def("exp", &Tensor::Exp);
tensor.def("exp_", &Tensor::Exp_);
tensor.def("abs", &Tensor::Abs);
tensor.def("abs_", &Tensor::Abs_);
tensor.def("isnan", &Tensor::IsNan);
tensor.def("isinf", &Tensor::IsInf);
tensor.def("isfinite", &Tensor::IsFinite);
tensor.def("floor", &Tensor::Floor);
tensor.def("ceil", &Tensor::Ceil);
tensor.def("round", &Tensor::Round);
tensor.def("trunc", &Tensor::Trunc);
tensor.def("logical_not", &Tensor::LogicalNot);
tensor.def("logical_not_", &Tensor::LogicalNot_);
BIND_CLIP_SCALAR(clip, Clip, CONST_ARG);
BIND_CLIP_SCALAR(clip_, Clip_, NON_CONST_ARG);
// Boolean.
tensor.def(
"nonzero",
[](const Tensor& tensor, bool as_tuple) -> py::object {
if (as_tuple) {
return py::cast(tensor.NonZero());
} else {
return py::cast(tensor.NonZeroNumpy());
}
},
"Find the indices of the elements that are non-zero.",
"as_tuple"_a = false);
docstring::ClassMethodDocInject(
m, "Tensor", "nonzero",
{{"as_tuple",
"If ``as_tuple`` is True, returns an int64 tensor of shape "
"{num_dims, num_non_zeros}, where the i-th row contains the "
"indices of the non-zero elements in i-th dimension of the "
"original tensor. If ``as_tuple`` is False, Returns a vector of "
"int64 Tensors, each containing the indices of the non-zero "
"elements in each dimension."}});
tensor.def(
"all", &Tensor::All, py::call_guard<py::gil_scoped_release>(),
py::arg("dim") = py::none(), py::arg("keepdim") = false,
"Returns true if all elements in the tensor are true. Only works "
"for boolean tensors.");
tensor.def(
"any", &Tensor::Any, py::call_guard<py::gil_scoped_release>(),
py::arg("dim") = py::none(), py::arg("keepdim") = false,
"Returns true if any elements in the tensor are true. Only works "
"for boolean tensors.");
// Reduction ops.
BIND_REDUCTION_OP(sum, Sum);
BIND_REDUCTION_OP(mean, Mean);
BIND_REDUCTION_OP(prod, Prod);
BIND_REDUCTION_OP(min, Min);
BIND_REDUCTION_OP(max, Max);
BIND_REDUCTION_OP_NO_KEEPDIM(argmin, ArgMin);
BIND_REDUCTION_OP_NO_KEEPDIM(argmax, ArgMax);
// Comparison.
tensor.def(
"allclose", &Tensor::AllClose, "other"_a, "rtol"_a = 1e-5,
"atol"_a = 1e-8,
R"(Returns true if the two tensors are element-wise equal within a tolerance.
- If the ``device`` is not the same: throws exception.
- If the ``dtype`` is not the same: throws exception.
- If the ``shape`` is not the same: returns false.
- Returns true if: ``abs(self - other) <= (atol + rtol * abs(other)``).
The equation is not symmetrical, i.e. ``a.allclose(b)`` might not be the same
as ``b.allclose(a)``. Also see `Numpy's documentation <https://numpy.org/doc/stable/reference/generated/numpy.allclose.html>`__.
TODO:
Support nan.)");
docstring::ClassMethodDocInject(
m, "Tensor", "allclose",
{{"other", "The other tensor to compare with."},
{"rtol", "Relative tolerance."},
{"atol", "Absolute tolerance."}});
tensor.def("isclose", &Tensor::IsClose, "other"_a, "rtol"_a = 1e-5,
"atol"_a = 1e-8,
R"(Element-wise version of ``tensor.allclose``.
- If the ``device`` is not the same: throws exception.
- If the ``dtype`` is not the same: throws exception.
- If the ``shape`` is not the same: throws exception.
- For each element in the returned tensor:
``abs(self - other) <= (atol + rtol * abs(other))``.
The equation is not symmetrical, i.e. a.is_close(b) might not be the same
as b.is_close(a). Also see `Numpy's documentation <https://numpy.org/doc/stable/reference/generated/numpy.isclose.html>`__.
TODO:
Support nan.
Returns:
A boolean tensor indicating where the tensor is close.)");
docstring::ClassMethodDocInject(
m, "Tensor", "isclose",
{{"other", "The other tensor to compare with."},
{"rtol", "Relative tolerance."},
{"atol", "Absolute tolerance."}});
tensor.def("issame", &Tensor::IsSame,
"Returns true iff the tensor is the other tensor. This "
"means that, the two tensors have the same underlying "
"memory, device, dtype, shape, strides and etc.");
// Print tensor.
tensor.def("__repr__",
[](const Tensor& tensor) { return tensor.ToString(); });
tensor.def("__str__",
[](const Tensor& tensor) { return tensor.ToString(); });
// Get item from Tensor of one element.
tensor.def(
"item",
[](const Tensor& tensor) -> py::object {
Dtype dtype = tensor.GetDtype();
if (dtype == core::Float32)
return py::float_(tensor.Item<float>());
if (dtype == core::Float64)
return py::float_(tensor.Item<double>());
if (dtype == core::Int8) return py::int_(tensor.Item<int8_t>());
if (dtype == core::Int16)
return py::int_(tensor.Item<int16_t>());
if (dtype == core::Int32)
return py::int_(tensor.Item<int32_t>());
if (dtype == core::Int64)
return py::int_(tensor.Item<int64_t>());
if (dtype == core::UInt8)
return py::int_(tensor.Item<uint8_t>());
if (dtype == core::UInt16)
return py::int_(tensor.Item<uint16_t>());
if (dtype == core::UInt32)
return py::int_(tensor.Item<uint32_t>());
if (dtype == core::UInt64)
return py::int_(tensor.Item<uint64_t>());
if (dtype == core::Bool) return py::bool_(tensor.Item<bool>());
utility::LogError(
"Tensor.item(): unsupported dtype to convert to "
"python.");
return py::none();
},
"Helper function to return the scalar value of a scalar tensor. "
"The tensor must be 0 - dimensional (i.e. have an empty shape).");
}
} // namespace core
} // namespace open3d
|
