Skip to content

[FEA]: Python refactoring of the neighborhood sampling API #5204

@jnke2016

Description

@jnke2016

Is this a new feature, an improvement, or a change to existing functionality?

Change

How would you describe the priority of this feature request

Medium

Please provide a clear description of problem this feature solves

The python cuGraph API currently host some of the GNN sampling functionality like heterogeneous sampling support and still has deprecated sampling functions. For context, uniform_neighbor_sample was deprecated in favor of either heterogeneous or homogeneous neighbor sample and the python API should only support the latter while the former should only be supported through the PLC layer

Describe your ideal solution

Below are the proposed refactoring tasks

  • Deprecate and later drop heterogeneous neighbor sample from the python cugraph API
  • Drop the deprecated uniform neighbor sample API from the python, PLC, C and C++ API
  • Perhaps maintain the sampling nomenclature as uniform_neighbor_sample and biased_neighbor_sample since the prefix homogeneous and heterogeneous are suitable for GNN
  • Update the python uniform_neighbor_sample and biased_neighbor_sample to respectively call the PLC homogeneous_uniform_neighbor_sample and homogeneous_biased_neighbor_sample without introducing a breaking change to the API
  • If we maintain the sampling nomenclature as uniform_neighbor_sample and biased_neighbor_sample, also deprecate and later drop homogeneous_uniform_neighbor_sample and homogeneous_biased_neighbor_sample from the python API

Describe any alternatives you have considered

No response

Additional context

No response

Code of Conduct

  • I agree to follow cuGraph's Code of Conduct
  • I have searched the open feature requests and have found no duplicates for this feature request

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions