Skip to content

Commit

Permalink
update CAPI
Browse files Browse the repository at this point in the history
  • Loading branch information
@jnke2016
jnke2016 committed Sep 20, 2024
1 parent 0358c6e commit 799c35d
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 62 deletions.
44 changes: 14 additions & 30 deletions cpp/include/cugraph_c/sampling_algorithms.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -509,20 +509,14 @@ cugraph_error_code_t cugraph_biased_neighbor_sample(
* @param [in] edge_biases Device array of edge biases to use for sampling. If NULL
* use the edge weight as the bias. If set to NULL, edges will be sampled uniformly.
* @param [in] start_vertices Device array of start vertices for the sampling
* @param [in] start_vertex_labels Device array of start vertex labels for the sampling. The
* labels associated with each start vertex will be included in the output associated with results
* that were derived from that start vertex. We only support label of type INT32. If label is
* NULL, the return data will not be labeled.
* @param [in] label_list Device array of the labels included in @p start_vertex_labels. If
* @p label_to_comm_rank is not specified this parameter is ignored. If specified, label_list
* must be sorted in ascending order.
* @param [in] start_vertex_offsets Device array of the offsets for each label in the seed list. This
* parameter is only used with the retain_seeds option.
* @param [in] label_to_comm_rank Device array identifying which comm rank the output for a
* particular label should be shuffled in the output. If not specifed the data is not organized in
* output. If specified then the all data from @p label_list[i] will be shuffled to rank @p. This
* cannot be specified unless @p start_vertex_labels is also specified
* particular label should be shuffled in the output based on the @p start_vertex_offsets.
* If not specifed the data is not organized in output. If specified then the all data in the range
* @p start_vertex_offsets[i+1] - @p start_vertex_offsets[i] will be shuffled to rank @p. This
* cannot be specified unless @p start_vertex_offsets is also specified.
* label_to_comm_rank[i]. If not specified then the output data will not be shuffled between ranks.
* @param [in] label_offsets Device array of the offsets for each label in the seed list. This
* parameter is only used with the retain_seeds option.
* @param [in] fan_out Host array defining the fan out at each step in the sampling algorithm.
* We only support fan_out values of type INT32
* @param [in] num_edge_types Number of edge types where a value of 1 translates to homogeneous neighbor
Expand All @@ -546,10 +540,8 @@ cugraph_error_code_t cugraph_heterogeneous_neighbor_sample(
cugraph_graph_t* graph,
const cugraph_edge_property_view_t* edge_biases,
const cugraph_type_erased_device_array_view_t* start_vertices,
const cugraph_type_erased_device_array_view_t* start_vertex_labels,
const cugraph_type_erased_device_array_view_t* label_list,
const cugraph_type_erased_device_array_view_t* start_vertex_offsets,
const cugraph_type_erased_device_array_view_t* label_to_comm_rank,
const cugraph_type_erased_device_array_view_t* label_offsets,
const cugraph_sample_heterogeneous_fan_out_t* fan_out,
int num_edge_types,
const cugraph_sampling_options_t* options,
Expand Down Expand Up @@ -577,20 +569,14 @@ cugraph_error_code_t cugraph_heterogeneous_neighbor_sample(
* @param [in] edge_biases Device array of edge biases to use for sampling. If NULL
* use the edge weight as the bias. If set to NULL, edges will be sampled uniformly.
* @param [in] start_vertices Device array of start vertices for the sampling
* @param [in] start_vertex_labels Device array of start vertex labels for the sampling. The
* labels associated with each start vertex will be included in the output associated with results
* that were derived from that start vertex. We only support label of type INT32. If label is
* NULL, the return data will not be labeled.
* @param [in] label_list Device array of the labels included in @p start_vertex_labels. If
* @p label_to_comm_rank is not specified this parameter is ignored. If specified, label_list
* must be sorted in ascending order.
* @param [in] start_vertex_offsets Device array of the offsets for each label in the seed list. This
* parameter is only used with the retain_seeds option.
* @param [in] label_to_comm_rank Device array identifying which comm rank the output for a
* particular label should be shuffled in the output. If not specifed the data is not organized in
* output. If specified then the all data from @p label_list[i] will be shuffled to rank @p. This
* cannot be specified unless @p start_vertex_labels is also specified
* particular label should be shuffled in the output based on the @p start_vertex_offsets.
* If not specifed the data is not organized in output. If specified then the all data in the range
* @p start_vertex_offsets[i+1] - @p start_vertex_offsets[i] will be shuffled to rank @p. This
* cannot be specified unless @p start_vertex_offsets is also specified.
* label_to_comm_rank[i]. If not specified then the output data will not be shuffled between ranks.
* @param [in] label_offsets Device array of the offsets for each label in the seed list. This
* parameter is only used with the retain_seeds option.
* @param [in] fan_out Host array defining the fan out at each step in the sampling algorithm.
* We only support fan_out values of type INT32
* @param [in] sampling_options
Expand All @@ -611,10 +597,8 @@ cugraph_error_code_t cugraph_homogeneous_neighbor_sample(
cugraph_graph_t* graph,
const cugraph_edge_property_view_t* edge_biases,
const cugraph_type_erased_device_array_view_t* start_vertices,
const cugraph_type_erased_device_array_view_t* start_vertex_labels,
const cugraph_type_erased_device_array_view_t* label_list,
const cugraph_type_erased_device_array_view_t* start_vertex_offsets,
const cugraph_type_erased_device_array_view_t* label_to_comm_rank,
const cugraph_type_erased_device_array_view_t* label_offsets,
const cugraph_type_erased_host_array_view_t* fan_out,
const cugraph_sampling_options_t* options,
bool_t is_biased,
Expand Down
56 changes: 24 additions & 32 deletions cpp/src/c_api/neighbor_sampling.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ struct neighbor_sampling_functor : public cugraph::c_api::abstract_functor {
int num_edge_types_{};
cugraph::c_api::cugraph_sampling_options_t options_{};
bool is_biased_{false};
bool is_deprecated_{false};
bool is_deprecated_api_{false};
bool do_expensive_check_{false};
cugraph::c_api::cugraph_sample_result_t* result_{nullptr};

Expand All @@ -107,7 +107,7 @@ struct neighbor_sampling_functor : public cugraph::c_api::abstract_functor {
int num_edge_types,
cugraph::c_api::cugraph_sampling_options_t options,
bool is_biased,
bool is_deprecated,
bool is_deprecated_api,
bool do_expensive_check)
: abstract_functor(),
handle_(*reinterpret_cast<cugraph::c_api::cugraph_resource_handle_t const*>(handle)->handle_),
Expand Down Expand Up @@ -137,7 +137,7 @@ struct neighbor_sampling_functor : public cugraph::c_api::abstract_functor {
num_edge_types_(num_edge_types),
options_(options),
is_biased_(is_biased),
is_deprecated_(is_deprecated),
is_deprecated_api_(is_deprecated_api),
do_expensive_check_(do_expensive_check)
{
}
Expand Down Expand Up @@ -250,7 +250,7 @@ struct neighbor_sampling_functor : public cugraph::c_api::abstract_functor {
std::optional<rmm::device_uvector<size_t>> offsets{std::nullopt};

// if 'start_vertex_offsets' is not NULL, leverage the new API
if (is_deprecated_) {
if (is_deprecated_api_) {
if (is_biased_) {
// Call biased neighbor sample
auto&& [src, dst, wgt, edge_id, edge_type, hop, edge_label, offsets] =
Expand Down Expand Up @@ -554,7 +554,7 @@ struct neighbor_sampling_functor : public cugraph::c_api::abstract_functor {
raft::device_span<vertex_t const>{
vertex_type_offsets.data(), vertex_type_offsets.size()},

edge_label ? edge_label->size() : size_t{1}, // FIXME: update edge_label
start_vertex_offsets ? start_vertex_offsets->size() : size_t{1},
hop ? fan_out_->size_ : size_t{1},
size_t{1},
size_t{1},
Expand All @@ -580,6 +580,10 @@ struct neighbor_sampling_functor : public cugraph::c_api::abstract_functor {
CUGRAPH_FAIL("Can only use COO format if not renumbering");
}

if (num_edge_types_ != 1) {
CUGRAPH_FAIL("Can only use COO format for homogeneous neighborhood sampling");
}

std::tie(src, dst, wgt, edge_id, edge_type, label_hop_offsets) =
cugraph::sort_sampled_edgelist(handle_,
std::move(src),
Expand Down Expand Up @@ -1193,7 +1197,7 @@ cugraph_error_code_t cugraph_uniform_neighbor_sample(
1,
std::move(options_cpp),
is_biased,
true, // is_deprecated
true, // is_deprecated_api
do_expensive_check};
return cugraph::c_api::run_algorithm(graph, functor, result, error);
}
Expand Down Expand Up @@ -1278,7 +1282,7 @@ cugraph_error_code_t cugraph_biased_neighbor_sample(
1,
std::move(options_cpp),
is_biased,
true, // is_deprecated
true, // is_deprecated_api
do_expensive_check};
return cugraph::c_api::run_algorithm(graph, functor, result, error);
}
Expand All @@ -1290,9 +1294,7 @@ cugraph_error_code_t cugraph_heterogeneous_neighbor_sample(
const cugraph_edge_property_view_t* edge_biases,
const cugraph_type_erased_device_array_view_t* start_vertices,
const cugraph_type_erased_device_array_view_t* start_vertex_offsets,
const cugraph_type_erased_device_array_view_t* label_list,
const cugraph_type_erased_device_array_view_t* label_to_comm_rank,
const cugraph_type_erased_device_array_view_t* label_offsets,
const cugraph_type_erased_host_array_view_t* fan_out,
int num_edge_types,
const cugraph_sampling_options_t* options,
Expand All @@ -1312,9 +1314,10 @@ cugraph_error_code_t cugraph_heterogeneous_neighbor_sample(
*error);
}

CAPI_EXPECTS((!options_cpp.retain_seeds_) || (label_offsets != nullptr),
// FIXME: Should we maintain this contition?
CAPI_EXPECTS((!options_cpp.retain_seeds_) || (start_vertex_offsets != nullptr),
CUGRAPH_INVALID_INPUT,
"must specify label_offsets if retain_seeds is true",
"must specify start_vertex_offsets if retain_seeds is true",
*error);

CAPI_EXPECTS((start_vertex_offsets == nullptr) ||
Expand All @@ -1329,11 +1332,6 @@ cugraph_error_code_t cugraph_heterogeneous_neighbor_sample(
CUGRAPH_INVALID_INPUT,
"cannot specify label_to_comm_rank unless start_vertex_offsets is also specified",
*error);

CAPI_EXPECTS((label_to_comm_rank == nullptr) || (label_list != nullptr),
CUGRAPH_INVALID_INPUT,
"cannot specify label_to_comm_rank unless label_list is also specified",
*error);

CAPI_EXPECTS(
reinterpret_cast<cugraph::c_api::cugraph_type_erased_host_array_view_t const*>(fan_out)
Expand All @@ -1355,16 +1353,16 @@ cugraph_error_code_t cugraph_heterogeneous_neighbor_sample(
graph,
edge_biases,
start_vertices,
nullptr, //start_vertex_labels /*Deprecated flag*/
nullptr, // start_vertex_labels /*Deprecated flag*/
start_vertex_offsets,
label_list,
nullptr, // label_list /*Deprecated flag*/
label_to_comm_rank,
label_offsets,
nullptr, // label_offsets /*Deprecated flag*/
fan_out,
num_edge_types,
std::move(options_cpp),
is_biased,
false, // is_deprecated
false, // is_deprecated_api
do_expensive_check};
return cugraph::c_api::run_algorithm(graph, functor, result, error);
}
Expand All @@ -1376,9 +1374,7 @@ cugraph_error_code_t cugraph_homogeneous_neighbor_sample(
const cugraph_edge_property_view_t* edge_biases,
const cugraph_type_erased_device_array_view_t* start_vertices,
const cugraph_type_erased_device_array_view_t* start_vertex_offsets,
const cugraph_type_erased_device_array_view_t* label_list,
const cugraph_type_erased_device_array_view_t* label_to_comm_rank,
const cugraph_type_erased_device_array_view_t* label_offsets,
const cugraph_type_erased_host_array_view_t* fan_out,
const cugraph_sampling_options_t* options,
bool_t is_biased,
Expand All @@ -1397,9 +1393,10 @@ cugraph_error_code_t cugraph_homogeneous_neighbor_sample(
*error);
}

CAPI_EXPECTS((!options_cpp.retain_seeds_) || (label_offsets != nullptr),
// FIXME: Should we maintain this contition?
CAPI_EXPECTS((!options_cpp.retain_seeds_) || (start_vertex_offsets != nullptr),
CUGRAPH_INVALID_INPUT,
"must specify label_offsets if retain_seeds is true",
"must specify start_vertex_offsets if retain_seeds is true",
*error);

CAPI_EXPECTS((start_vertex_offsets == nullptr) ||
Expand All @@ -1414,11 +1411,6 @@ cugraph_error_code_t cugraph_homogeneous_neighbor_sample(
CUGRAPH_INVALID_INPUT,
"cannot specify label_to_comm_rank unless start_vertex_offsets is also specified",
*error);

CAPI_EXPECTS((label_to_comm_rank == nullptr) || (label_list != nullptr),
CUGRAPH_INVALID_INPUT,
"cannot specify label_to_comm_rank unless label_list is also specified",
*error);

CAPI_EXPECTS(reinterpret_cast<cugraph::c_api::cugraph_type_erased_host_array_view_t const*>(
fan_out)
Expand All @@ -1443,14 +1435,14 @@ cugraph_error_code_t cugraph_homogeneous_neighbor_sample(
start_vertices,
nullptr, //start_vertex_labels /*Deprecated flag*/
start_vertex_offsets,
label_list,
nullptr,//label_list /*Deprecated flag*/
label_to_comm_rank,
label_offsets,
nullptr, //label_offsets /*Deprecated flag*/
fan_out,
1,
std::move(options_cpp),
is_biased,
false, // is_deprecated
false, // is_deprecated_api
do_expensive_check};
return cugraph::c_api::run_algorithm(graph, functor, result, error);
}
Expand Down

0 comments on commit 799c35d

Please sign in to comment.