turicreate.kcore.KcoreModel

class turicreate.kcore.KcoreModel(model)

A KcoreModel object contains a core ID for each vertex, and the total number of cores in the graph.

The core ID of a vertex is a measure of its global centrality.

The algorithms iteratively remove vertices that has less than \(k\) neighbors recursively. The algorithm guarantees that at iteration \(k+1\), all vertices left in the graph will have at least \(k+1\) neighbors. The vertices removed at iteration \(k\) is assigned with a core ID equal to \(k\).

Below is a list of queryable fields for this model:

Field Description
core_id An SFrame with each vertex’s core id
graph A new SGraph with the core id as a vertex property
kmax The maximum core id assigned to any vertex
kmin The minimum core id assigned to any vertex
training_time Total training time of the model

This model cannot be constructed directly. Instead, use turicreate.kcore.create() to create an instance of this model. A detailed list of parameter options and code samples are available in the documentation for the create function.

See also

create

Methods

KcoreModel.name() Returns the name of the model.
KcoreModel.save(location) Save the model.
KcoreModel.summary([output]) Print a summary of the model.