rok commented on code in PR #8510: URL: https://github.com/apache/arrow/pull/8510#discussion_r1124238016
########## cpp/src/arrow/extension/fixed_shape_tensor_test.cc: ########## @@ -0,0 +1,293 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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. + +#include "arrow/extension/fixed_shape_tensor.h" + +#include "arrow/testing/matchers.h" + +#include "arrow/array/array_nested.h" +#include "arrow/array/array_primitive.h" +#include "arrow/io/memory.h" +#include "arrow/ipc/reader.h" +#include "arrow/ipc/writer.h" +#include "arrow/record_batch.h" +#include "arrow/tensor.h" +#include "arrow/testing/gtest_util.h" +#include "arrow/util/key_value_metadata.h" + +namespace arrow { + +using FixedShapeTensorType = extension::FixedShapeTensorType; +using extension::fixed_shape_tensor; + +class TestExtensionType : public ::testing::Test { + public: + void SetUp() override { + shape_ = {3, 3, 4}; + cell_shape_ = {3, 4}; + value_type_ = int64(); + cell_type_ = fixed_size_list(value_type_, 12); + dim_names_ = {"x", "y"}; + ext_type_ = fixed_shape_tensor(value_type_, cell_shape_, {}, dim_names_); + values_ = {0, 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}; + values_partial_ = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, + 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23}; + shape_partial_ = {2, 3, 4}; + tensor_strides_ = {96, 32, 8}; + cell_strides_ = {32, 8}; + serialized_ = R"({"shape":[3,4],"dim_names":["x","y"]})"; + } + + protected: + std::vector<int64_t> shape_; + std::vector<int64_t> shape_partial_; + std::vector<int64_t> cell_shape_; + std::shared_ptr<DataType> value_type_; + std::shared_ptr<DataType> cell_type_; + std::vector<std::string> dim_names_; + std::shared_ptr<ExtensionType> ext_type_; + std::vector<int64_t> values_; + std::vector<int64_t> values_partial_; + std::vector<int64_t> tensor_strides_; + std::vector<int64_t> cell_strides_; + std::string serialized_; +}; + +auto RoundtripBatch = [](const std::shared_ptr<RecordBatch>& batch, + std::shared_ptr<RecordBatch>* out) { + ASSERT_OK_AND_ASSIGN(auto out_stream, io::BufferOutputStream::Create()); + ASSERT_OK(ipc::WriteRecordBatchStream({batch}, ipc::IpcWriteOptions::Defaults(), + out_stream.get())); + + ASSERT_OK_AND_ASSIGN(auto complete_ipc_stream, out_stream->Finish()); + + io::BufferReader reader(complete_ipc_stream); + std::shared_ptr<RecordBatchReader> batch_reader; + ASSERT_OK_AND_ASSIGN(batch_reader, ipc::RecordBatchStreamReader::Open(&reader)); + ASSERT_OK(batch_reader->ReadNext(out)); +}; + +TEST_F(TestExtensionType, CheckDummyRegistration) { + // We need a dummy registration at runtime to allow for IPC deserialization + auto ext_type = fixed_shape_tensor(int64(), {}); + auto registered_type = GetExtensionType(ext_type->extension_name()); + ASSERT_TRUE(registered_type->Equals(*ext_type)); +} + +TEST_F(TestExtensionType, CreateExtensionType) { + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + + // Test ExtensionType methods + ASSERT_EQ(ext_type_->extension_name(), "arrow.fixed_shape_tensor"); + ASSERT_TRUE(ext_type_->Equals(*exact_ext_type)); + ASSERT_TRUE(ext_type_->storage_type()->Equals(*cell_type_)); + ASSERT_EQ(ext_type_->Serialize(), serialized_); + ASSERT_OK_AND_ASSIGN(auto ds, + ext_type_->Deserialize(ext_type_->storage_type(), serialized_)); + auto deserialized = std::reinterpret_pointer_cast<ExtensionType>(ds); + ASSERT_TRUE(deserialized->Equals(*ext_type_)); + + // Test FixedShapeTensorType methods + ASSERT_EQ(exact_ext_type->id(), Type::EXTENSION); + ASSERT_EQ(exact_ext_type->ndim(), cell_shape_.size()); + ASSERT_EQ(exact_ext_type->shape(), cell_shape_); + ASSERT_EQ(exact_ext_type->strides(), cell_strides_); + ASSERT_EQ(exact_ext_type->dim_names(), dim_names_); +} + +TEST_F(TestExtensionType, CreateFromArray) { + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + + std::vector<std::shared_ptr<Buffer>> buffers = {nullptr, Buffer::Wrap(values_)}; + auto arr_data = std::make_shared<ArrayData>(value_type_, values_.size(), buffers, 0, 0); + auto arr = std::make_shared<Int64Array>(arr_data); + EXPECT_OK_AND_ASSIGN(auto fsla_arr, FixedSizeListArray::FromArrays(arr, cell_type_)); + auto data = fsla_arr->data(); + data->type = ext_type_; + auto ext_arr = exact_ext_type->MakeArray(data); + ASSERT_EQ(ext_arr->length(), shape_[0]); + ASSERT_EQ(ext_arr->null_count(), 0); +} + +TEST_F(TestExtensionType, CreateFromTensor) { + std::vector<int64_t> column_major_strides = {8, 24, 72}; + std::vector<int64_t> neither_major_strides = {96, 8, 32}; + + ASSERT_OK_AND_ASSIGN(auto tensor, + Tensor::Make(value_type_, Buffer::Wrap(values_), shape_)); + + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + EXPECT_OK_AND_ASSIGN(auto ext_arr, exact_ext_type->MakeArray(tensor)); + + ASSERT_OK(ext_arr->ValidateFull()); + ASSERT_TRUE(tensor->is_row_major()); + ASSERT_EQ(tensor->strides(), tensor_strides_); + ASSERT_EQ(ext_arr->length(), shape_[0]); + + auto ext_type_2 = fixed_shape_tensor(int64(), {3, 4}, {0, 1}); + EXPECT_OK_AND_ASSIGN(auto ext_arr_2, ext_type_2->MakeArray(tensor)); + + ASSERT_OK_AND_ASSIGN( + auto column_major_tensor, + Tensor::Make(value_type_, Buffer::Wrap(values_), shape_, column_major_strides)); + auto ext_type_3 = fixed_shape_tensor(int64(), {3, 4}, {0, 1}); + EXPECT_RAISES_WITH_MESSAGE_THAT( + Invalid, + testing::HasSubstr( + "Invalid: Only first-major tensors can be zero-copy converted to arrays"), + ext_type_3->MakeArray(column_major_tensor)); + ASSERT_THAT(ext_type_3->MakeArray(column_major_tensor), Raises(StatusCode::Invalid)); + + auto neither_major_tensor = std::make_shared<Tensor>(value_type_, Buffer::Wrap(values_), + shape_, neither_major_strides); + auto ext_type_4 = fixed_shape_tensor(int64(), {3, 4}, {1, 0}); + ASSERT_OK_AND_ASSIGN(auto ext_arr_4, ext_type_4->MakeArray(neither_major_tensor)); +} + +TEST_F(TestExtensionType, RoundtripTensor) { + ASSERT_OK_AND_ASSIGN(auto tensor, + Tensor::Make(value_type_, Buffer::Wrap(values_), shape_)); + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + EXPECT_OK_AND_ASSIGN(auto ext_arr, exact_ext_type->MakeArray(tensor)); + + EXPECT_OK_AND_ASSIGN(auto tensor_from_array, exact_ext_type->ToTensor(ext_arr)); + ASSERT_EQ(tensor_from_array->shape(), tensor->shape()); + ASSERT_EQ(tensor_from_array->strides(), tensor->strides()); + ASSERT_TRUE(tensor->Equals(*tensor_from_array)); +} + +TEST_F(TestExtensionType, SliceTensor) { + ASSERT_OK_AND_ASSIGN(auto tensor, + Tensor::Make(value_type_, Buffer::Wrap(values_), shape_)); + ASSERT_OK_AND_ASSIGN( + auto tensor_partial, + Tensor::Make(value_type_, Buffer::Wrap(values_partial_), shape_partial_)); + ASSERT_EQ(tensor->strides(), tensor_strides_); + ASSERT_EQ(tensor_partial->strides(), tensor_strides_); + auto ext_type = fixed_shape_tensor(value_type_, cell_shape_, {}, dim_names_); + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + + EXPECT_OK_AND_ASSIGN(auto ext_arr, exact_ext_type->MakeArray(tensor)); + EXPECT_OK_AND_ASSIGN(auto ext_arr_partial, exact_ext_type->MakeArray(tensor_partial)); + ASSERT_OK(ext_arr->ValidateFull()); + ASSERT_OK(ext_arr_partial->ValidateFull()); + + auto sliced = internal::checked_pointer_cast<ExtensionArray>(ext_arr->Slice(0, 2)); + auto partial = internal::checked_pointer_cast<ExtensionArray>(ext_arr_partial); + + ASSERT_TRUE(sliced->Equals(*partial)); + ASSERT_OK(sliced->ValidateFull()); + ASSERT_OK(partial->ValidateFull()); + ASSERT_TRUE(sliced->storage()->Equals(*partial->storage())); + ASSERT_EQ(sliced->length(), partial->length()); +} + +void CheckSerializationRoundtrip(const std::shared_ptr<ExtensionType>& ext_type) { + auto serialized = ext_type->Serialize(); + ASSERT_OK_AND_ASSIGN(auto deserialized, + ext_type->Deserialize(ext_type->storage_type(), serialized)); + ASSERT_TRUE(ext_type->Equals(*deserialized)); +} + +TEST_F(TestExtensionType, MetadataSerializationRoundtrip) { + CheckSerializationRoundtrip(fixed_shape_tensor(value_type_, {}, {}, {})); + CheckSerializationRoundtrip(fixed_shape_tensor(value_type_, {0}, {}, {})); + CheckSerializationRoundtrip(fixed_shape_tensor(value_type_, {1}, {0}, {"x"})); + CheckSerializationRoundtrip( + fixed_shape_tensor(value_type_, {256, 256, 3}, {0, 1, 2}, {"H", "W", "C"})); + CheckSerializationRoundtrip( + fixed_shape_tensor(value_type_, {256, 256, 3}, {2, 0, 1}, {"C", "H", "W"})); + + auto ext_type = fixed_shape_tensor(value_type_, cell_shape_, {0, 1}, dim_names_); + CheckSerializationRoundtrip(ext_type_); + + EXPECT_RAISES_WITH_MESSAGE_THAT( + Invalid, testing::HasSubstr("Invalid: Expected FixedSizeList storage type"), + ext_type->Deserialize(boolean(), serialized_)); +} + +TEST_F(TestExtensionType, RoudtripBatch) { + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + + std::vector<std::shared_ptr<Buffer>> buffers = {nullptr, Buffer::Wrap(values_)}; + auto arr_data = std::make_shared<ArrayData>(value_type_, values_.size(), buffers, 0, 0); + auto arr = std::make_shared<Int64Array>(arr_data); + EXPECT_OK_AND_ASSIGN(auto fsla_arr, FixedSizeListArray::FromArrays(arr, cell_type_)); + auto data = fsla_arr->data(); + data->type = ext_type_; + auto ext_arr = exact_ext_type->MakeArray(data); + + ASSERT_OK(UnregisterExtensionType(ext_type_->extension_name())); + ASSERT_OK(RegisterExtensionType(ext_type_)); + auto ext_metadata = + key_value_metadata({{"ARROW:extension:name", exact_ext_type->extension_name()}, + {"ARROW:extension:metadata", serialized_}}); + auto ext_field = field("f0", exact_ext_type, true, ext_metadata); + auto batch = RecordBatch::Make(schema({ext_field}), ext_arr->length(), {ext_arr}); + std::shared_ptr<RecordBatch> read_batch; + RoundtripBatch(batch, &read_batch); + CompareBatch(*batch, *read_batch, /*compare_metadata=*/true); +} + +TEST_F(TestExtensionType, RoudtripBatchFromTensor) { + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + ASSERT_OK_AND_ASSIGN(auto tensor, Tensor::Make(value_type_, Buffer::Wrap(values_), + shape_, {}, dim_names_)); + EXPECT_OK_AND_ASSIGN(auto ext_arr, exact_ext_type->MakeArray(tensor)); + ext_arr->data()->type = exact_ext_type; + + ASSERT_OK(UnregisterExtensionType(ext_type_->extension_name())); + ASSERT_OK(RegisterExtensionType(ext_type_)); + auto ext_metadata = + key_value_metadata({{"ARROW:extension:name", ext_type_->extension_name()}, + {"ARROW:extension:metadata", serialized_}}); + auto ext_field = field("f0", ext_type_, true, ext_metadata); + auto batch = RecordBatch::Make(schema({ext_field}), ext_arr->length(), {ext_arr}); + std::shared_ptr<RecordBatch> read_batch; + RoundtripBatch(batch, &read_batch); + CompareBatch(*batch, *read_batch, /*compare_metadata=*/true); +} + +TEST_F(TestExtensionType, ComputeStrides) { + auto exact_ext_type = internal::checked_pointer_cast<FixedShapeTensorType>(ext_type_); + + auto ext_type_1 = fixed_shape_tensor(int64(), cell_shape_, {}, dim_names_); + auto ext_type_2 = fixed_shape_tensor(int64(), cell_shape_, {}, dim_names_); + auto ext_type_3 = fixed_shape_tensor(int32(), cell_shape_, {}, dim_names_); + ASSERT_TRUE(ext_type_1->Equals(*ext_type_2)); + ASSERT_FALSE(ext_type_1->Equals(*ext_type_3)); + + auto ext_type_4 = fixed_shape_tensor(int64(), {3, 4, 7}, {}, {"x", "y", "z"}); + ASSERT_EQ(ext_type_4->strides(), (std::vector<int64_t>{224, 56, 8})); + ext_type_4 = fixed_shape_tensor(int64(), {3, 4, 7}, {0, 1, 2}, {"x", "y", "z"}); + ASSERT_EQ(ext_type_4->strides(), (std::vector<int64_t>{224, 56, 8})); + + auto ext_type_5 = fixed_shape_tensor(int64(), {3, 4, 7}, {1, 0, 2}); + ASSERT_EQ(ext_type_5->strides(), (std::vector<int64_t>{56, 224, 8})); + ASSERT_EQ(ext_type_5->Serialize(), R"({"shape":[3,4,7],"permutation":[1,0,2]})"); + + auto ext_type_6 = fixed_shape_tensor(int64(), {3, 4, 7}, {1, 2, 0}, {}); + ASSERT_EQ(ext_type_6->strides(), (std::vector<int64_t>{56, 8, 224})); + ASSERT_EQ(ext_type_6->Serialize(), R"({"shape":[3,4,7],"permutation":[1,2,0]})"); + + auto ext_type_7 = fixed_shape_tensor(int64(), {3, 4, 7}, {2, 0, 1}, {}); Review Comment: We didn't really discuss the strides in elements vs strides in bytes yet. I've reused logic from Tensor here which defaults to bytes, but I'm not attached to it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
