-
Notifications
You must be signed in to change notification settings - Fork 197
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add stream overloads to
ivf_pq serialize/deserialize methods (#1315)
Authors: - Divye Gala (https://github.com/divyegala) - Corey J. Nolet (https://github.com/cjnolet) Approvers: - William Hicks (https://github.com/wphicks) - Corey J. Nolet (https://github.com/cjnolet) URL: #1315
- Loading branch information
Showing
7 changed files
with
249 additions
and
52 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /* | ||
| * Copyright (c) 2023, 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 "detail/ivf_pq_serialize.cuh" | ||
|
|
||
| namespace raft::neighbors::ivf_pq { | ||
|
|
||
| /** | ||
| * \defgroup ivf_pq_serialize IVF-PQ Serialize | ||
| * @{ | ||
| */ | ||
|
|
||
| /** | ||
| * Write the index to an output stream | ||
| * | ||
| * Experimental, both the API and the serialization format are subject to change. | ||
| * | ||
| * @code{.cpp} | ||
| * #include <raft/core/device_resources.hpp> | ||
| * | ||
| * raft::device_resources handle; | ||
| * | ||
| * // create an output stream | ||
| * std::ostream os(std::cout.rdbuf()); | ||
| * // create an index with `auto index = ivf_pq::build(...);` | ||
| * raft::serailize(handle, os, index); | ||
| * @endcode | ||
| * | ||
| * @tparam IdxT type of the index | ||
| * | ||
| * @param[in] handle the raft handle | ||
| * @param[in] os output stream | ||
| * @param[in] index IVF-PQ index | ||
| * | ||
| * @return raft::neighbors::ivf_pq::index<IdxT> | ||
| */ | ||
| template <typename IdxT> | ||
| void serialize(raft::device_resources const& handle, std::ostream& os, const index<IdxT>& index) | ||
| { | ||
| detail::serialize(handle, os, index); | ||
| } | ||
|
|
||
| /** | ||
| * Save the index to file. | ||
| * | ||
| * Experimental, both the API and the serialization format are subject to change. | ||
| * | ||
| * @code{.cpp} | ||
| * #include <raft/core/device_resources.hpp> | ||
| * | ||
| * raft::device_resources handle; | ||
| * | ||
| * // create a string with a filepath | ||
| * std::string filename("/path/to/index"); | ||
| * // create an index with `auto index = ivf_pq::build(...);` | ||
| * raft::serailize(handle, filename, index); | ||
| * @endcode | ||
| * | ||
| * @tparam IdxT type of the index | ||
| * | ||
| * @param[in] handle the raft handle | ||
| * @param[in] filename the file name for saving the index | ||
| * @param[in] index IVF-PQ index | ||
| * | ||
| * @return raft::neighbors::ivf_pq::index<IdxT> | ||
| */ | ||
| template <typename IdxT> | ||
| void serialize(raft::device_resources const& handle, | ||
| const std::string& filename, | ||
| const index<IdxT>& index) | ||
| { | ||
| detail::serialize(handle, filename, index); | ||
| } | ||
|
|
||
| /** | ||
| * Load index from input stream | ||
| * | ||
| * Experimental, both the API and the serialization format are subject to change. | ||
| * | ||
| * @code{.cpp} | ||
| * #include <raft/core/device_resources.hpp> | ||
| * | ||
| * raft::device_resources handle; | ||
| * | ||
| * // create an input stream | ||
| * std::istream is(std::cin.rdbuf()); | ||
| * using IdxT = int; // type of the index | ||
| * auto index = raft::deserialize<IdxT>(handle, is); | ||
| * @endcode | ||
| * | ||
| * @tparam IdxT type of the index | ||
| * | ||
| * @param[in] handle the raft handle | ||
| * @param[in] is input stream | ||
| * | ||
| * @return raft::neighbors::ivf_pq::index<IdxT> | ||
| */ | ||
| template <typename IdxT> | ||
| index<IdxT> deserialize(raft::device_resources const& handle, std::istream& is) | ||
| { | ||
| return detail::deserialize<IdxT>(handle, is); | ||
| } | ||
|
|
||
| /** | ||
| * Load index from file. | ||
| * | ||
| * Experimental, both the API and the serialization format are subject to change. | ||
| * | ||
| * @code{.cpp} | ||
| * #include <raft/core/device_resources.hpp> | ||
| * | ||
| * raft::device_resources handle; | ||
| * | ||
| * // create a string with a filepath | ||
| * std::string filename("/path/to/index"); | ||
| * using IdxT = int; // type of the index | ||
| * auto index = raft::deserialize<IdxT>(handle, filename); | ||
| * @endcode | ||
| * | ||
| * @tparam IdxT type of the index | ||
| * | ||
| * @param[in] handle the raft handle | ||
| * @param[in] filename the name of the file that stores the index | ||
| * | ||
| * @return raft::neighbors::ivf_pq::index<IdxT> | ||
| */ | ||
| template <typename IdxT> | ||
| index<IdxT> deserialize(raft::device_resources const& handle, const std::string& filename) | ||
| { | ||
| return detail::deserialize<IdxT>(handle, filename); | ||
| } | ||
|
|
||
| /**@}*/ | ||
|
|
||
| } // namespace raft::neighbors::ivf_pq |
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
Oops, something went wrong.