Add hamming, jensen-shannon, kl-divergence, correlation and russellrao distance metrics #4155
+675
−144
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
|
|
||
| /* | ||
| * Copyright (c) 2021, NVIDIA CORPORATION. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #include <raft/distance/distance.cuh> | ||
| #include <raft/handle.hpp> | ||
| #include "pairwise_distance_correlation.cuh" | ||
|
|
||
| namespace ML { | ||
|
|
||
| namespace Metrics { | ||
| void pairwise_distance_correlation(const raft::handle_t& handle, | ||
| const double* x, | ||
| const double* y, | ||
| double* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| double metric_arg) | ||
| { | ||
| // Allocate workspace | ||
| raft::mr::device::buffer<char> workspace(handle.get_device_allocator(), handle.get_stream(), 1); | ||
|
|
||
| // Call the distance function | ||
| switch (metric) { | ||
| case raft::distance::DistanceType::CorrelationExpanded: | ||
| raft::distance:: | ||
| pairwise_distance_impl<double, int, raft::distance::DistanceType::CorrelationExpanded>( | ||
| x, y, dist, m, n, k, workspace, handle.get_stream(), isRowMajor); | ||
| break; | ||
| default: THROW("Unknown or unsupported distance metric '%d'!", (int)metric); | ||
| } | ||
| } | ||
|
|
||
| void pairwise_distance_correlation(const raft::handle_t& handle, | ||
| const float* x, | ||
| const float* y, | ||
| float* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| float metric_arg) | ||
| { | ||
| // Allocate workspace | ||
| raft::mr::device::buffer<char> workspace(handle.get_device_allocator(), handle.get_stream(), 1); | ||
|
|
||
| // Call the distance function | ||
| switch (metric) { | ||
| case raft::distance::DistanceType::CorrelationExpanded: | ||
|
There was a problem hiding this comment. Is the switch state propagated into this in case there is also an unexpanded version in the future? (Asking for the other distances as well) There was a problem hiding this comment. No there is no unexpanded version planned for this or other distance metrics. should I replace There was a problem hiding this comment. These functions are named after the associated distance measure so I would call a function named pairwise_distance_correlation expecting it to compute the correlation distance. If it's not possible that this will ever compute a distance other than correlation, why are we passing the DistanceType into these functions at all? Rather than using an if condition, I would propose removing the metric argument altogether and just having the function compute the distance for which its name implies. What do you think? There was a problem hiding this comment. Good point! I think the metric arg got propagated to all distances due to euclidean dist having multiple sub-implementations. |
||
| raft::distance:: | ||
| pairwise_distance_impl<float, int, raft::distance::DistanceType::CorrelationExpanded>( | ||
| x, y, dist, m, n, k, workspace, handle.get_stream(), isRowMajor); | ||
| break; | ||
| default: THROW("Unknown or unsupported distance metric '%d'!", (int)metric); | ||
| } | ||
| } | ||
|
|
||
| } // namespace Metrics | ||
| } // namespace ML | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
|
|
||
| /* | ||
| * Copyright (c) 2021, NVIDIA CORPORATION. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <raft/distance/distance.cuh> | ||
| #include <raft/handle.hpp> | ||
|
|
||
| namespace ML { | ||
|
|
||
| namespace Metrics { | ||
| void pairwise_distance_correlation(const raft::handle_t& handle, | ||
| const double* x, | ||
| const double* y, | ||
| double* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| double metric_arg); | ||
|
|
||
| void pairwise_distance_correlation(const raft::handle_t& handle, | ||
| const float* x, | ||
| const float* y, | ||
| float* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| float metric_arg); | ||
|
|
||
| } // namespace Metrics | ||
| } // namespace ML |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
|
|
||
| /* | ||
| * Copyright (c) 2021, NVIDIA CORPORATION. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #include <raft/distance/distance.cuh> | ||
| #include <raft/handle.hpp> | ||
| #include "pairwise_distance_hamming.cuh" | ||
|
|
||
| namespace ML { | ||
|
|
||
| namespace Metrics { | ||
| void pairwise_distance_hamming(const raft::handle_t& handle, | ||
| const double* x, | ||
| const double* y, | ||
| double* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| double metric_arg) | ||
| { | ||
| // Allocate workspace | ||
| raft::mr::device::buffer<char> workspace(handle.get_device_allocator(), handle.get_stream(), 0); | ||
|
|
||
| // Call the distance function | ||
| switch (metric) { | ||
| case raft::distance::DistanceType::HammingUnexpanded: | ||
| raft::distance:: | ||
| pairwise_distance_impl<double, int, raft::distance::DistanceType::HammingUnexpanded>( | ||
| x, y, dist, m, n, k, workspace, handle.get_stream(), isRowMajor); | ||
| break; | ||
| default: THROW("Unknown or unsupported distance metric '%d'!", (int)metric); | ||
| } | ||
| } | ||
|
|
||
| void pairwise_distance_hamming(const raft::handle_t& handle, | ||
| const float* x, | ||
| const float* y, | ||
| float* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| float metric_arg) | ||
| { | ||
| // Allocate workspace | ||
| raft::mr::device::buffer<char> workspace(handle.get_device_allocator(), handle.get_stream(), 0); | ||
|
|
||
| // Call the distance function | ||
| switch (metric) { | ||
| case raft::distance::DistanceType::HammingUnexpanded: | ||
| raft::distance:: | ||
| pairwise_distance_impl<float, int, raft::distance::DistanceType::HammingUnexpanded>( | ||
| x, y, dist, m, n, k, workspace, handle.get_stream(), isRowMajor); | ||
| break; | ||
| default: THROW("Unknown or unsupported distance metric '%d'!", (int)metric); | ||
| } | ||
| } | ||
|
|
||
| } // namespace Metrics | ||
| } // namespace ML |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
|
|
||
| /* | ||
| * Copyright (c) 2021, NVIDIA CORPORATION. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <raft/distance/distance.cuh> | ||
| #include <raft/handle.hpp> | ||
|
|
||
| namespace ML { | ||
|
|
||
| namespace Metrics { | ||
| void pairwise_distance_hamming(const raft::handle_t& handle, | ||
| const double* x, | ||
| const double* y, | ||
| double* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| double metric_arg); | ||
|
|
||
| void pairwise_distance_hamming(const raft::handle_t& handle, | ||
| const float* x, | ||
| const float* y, | ||
| float* dist, | ||
| int m, | ||
| int n, | ||
| int k, | ||
| raft::distance::DistanceType metric, | ||
| bool isRowMajor, | ||
| float metric_arg); | ||
|
|
||
| } // namespace Metrics | ||
| } // namespace ML |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminder to update this now that the raft side has been merged