Unverified Commit 4b73c375 authored by Hongzhi (Steve), Chen's avatar Hongzhi (Steve), Chen Committed by GitHub
Browse files

[misc] fix the comment format. (#5705)


Co-authored-by: default avatarUbuntu <ubuntu@ip-172-31-28-63.ap-northeast-1.compute.internal>
parent c92d012b
......@@ -71,21 +71,21 @@ struct HeteroInfo {
torch::Tensor type_per_edge;
/**
** @brief Magic number to indicate Hetero info version in serialize/
** deserialize stages.
**/
* @brief Magic number to indicate Hetero info version in serialize/
* deserialize stages.
*/
static constexpr int64_t kHeteroInfoSerializeMagic = 0xDD2E60F0F6B4A129;
/**
** @brief Load hetero info from stream.
** @param archive Input stream for deserializing.
**/
* @brief Load hetero info from stream.
* @param archive Input stream for deserializing.
*/
void Load(torch::serialize::InputArchive& archive);
/**
** @brief Save hetero info to stream.
** @param archive Output stream for serializing.
**/
* @brief Save hetero info to stream.
* @param archive Output stream for serializing.
*/
void Save(torch::serialize::OutputArchive& archive) const;
};
......@@ -170,21 +170,21 @@ class CSCSamplingGraph : public torch::CustomClassHolder {
}
/**
** @brief Magic number to indicate graph version in serialize/deserialize
** stage.
**/
* @brief Magic number to indicate graph version in serialize/deserialize
* stage.
*/
static constexpr int64_t kCSCSamplingGraphSerializeMagic = 0xDD2E60F0F6B4A128;
/**
** @brief Load graph from stream.
** @param archive Input stream for deserializing.
**/
* @brief Load graph from stream.
* @param archive Input stream for deserializing.
*/
void Load(torch::serialize::InputArchive& archive);
/**
** @brief Save graph to stream.
** @param archive Output stream for serializing.
**/
* @brief Save graph to stream.
* @param archive Output stream for serializing.
*/
void Save(torch::serialize::OutputArchive& archive) const;
private:
......@@ -202,18 +202,18 @@ class CSCSamplingGraph : public torch::CustomClassHolder {
} // namespace graphbolt
/**
** @brief Overload stream operator to enable `torch::save()` and `torch.load()`
** for CSCSamplingGraph.
**/
* @brief Overload stream operator to enable `torch::save()` and `torch.load()`
* for CSCSamplingGraph.
*/
namespace torch {
/**
** @brief Overload input stream operator for CSCSamplingGraph deserialization.
** @param archive Input stream for deserializing.
** @param graph CSCSamplingGraph.
**
** @return archive
**/
* @brief Overload input stream operator for CSCSamplingGraph deserialization.
* @param archive Input stream for deserializing.
* @param graph CSCSamplingGraph.
*
* @return archive
*/
inline serialize::InputArchive& operator>>(
serialize::InputArchive& archive,
graphbolt::sampling::CSCSamplingGraph& graph);
......
......@@ -20,7 +20,7 @@ namespace utils {
* @param archive Output archive.
* @param key Key name used in saving.
* @param data Data that could be constructed as `torch::IValue`.
**/
*/
template <typename DataT>
void write_to_archive(
torch::serialize::OutputArchive& archive, const std::string& key,
......@@ -33,7 +33,7 @@ void write_to_archive(
* @param archive Output archive.
* @param key Key name used in saving.
* @param data Vector of string.
**/
*/
template <>
void write_to_archive<std::vector<std::string>>(
torch::serialize::OutputArchive& archive, const std::string& key,
......@@ -50,7 +50,7 @@ void write_to_archive<std::vector<std::string>>(
* @param archive Input archive.
* @param key Key name used in reading.
* @param data Data that could be constructed as `torch::IValue`.
**/
*/
template <typename DataT = torch::IValue>
void read_from_archive(
torch::serialize::InputArchive& archive, const std::string& key,
......@@ -63,7 +63,7 @@ void read_from_archive(
* @param archive Input archive.
* @param key Key name used in reading.
* @param data Data that is `bool`.
**/
*/
template <>
void read_from_archive<bool>(
torch::serialize::InputArchive& archive, const std::string& key,
......@@ -78,7 +78,7 @@ void read_from_archive<bool>(
* @param archive Input archive.
* @param key Key name used in reading.
* @param data Data that is `int64_t`.
**/
*/
template <>
void read_from_archive<int64_t>(
torch::serialize::InputArchive& archive, const std::string& key,
......@@ -93,7 +93,7 @@ void read_from_archive<int64_t>(
* @param archive Input archive.
* @param key Key name used in reading.
* @param data Data that is `std::string`.
**/
*/
template <>
void read_from_archive<std::string>(
torch::serialize::InputArchive& archive, const std::string& key,
......@@ -108,7 +108,7 @@ void read_from_archive<std::string>(
* @param archive Input archive.
* @param key Key name used in reading.
* @param data Data that is `torch::Tensor`.
**/
*/
template <>
void read_from_archive<torch::Tensor>(
torch::serialize::InputArchive& archive, const std::string& key,
......@@ -123,7 +123,7 @@ void read_from_archive<torch::Tensor>(
* @param archive Output archive.
* @param key Key name used in saving.
* @param data Vector of string.
**/
*/
template <>
void read_from_archive<std::vector<std::string>>(
torch::serialize::InputArchive& archive, const std::string& key,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment