Skip to content

docs: Add documentation to Wayang API graph package object #736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AjayBoddeda4 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add documentation to Wayang API graph package object #736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph/package.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,18 @@ package org.apache.wayang.api
import org.apache.wayang.basic.data.{Tuple2 => T2}

/**
* Provides implicits for Wayang's graph API.
*/
* Provides implicit conversions and type aliases for Apache Wayang's graph API.
*
* This package object defines core type aliases used in graph processing pipelines:
* - Vertex: represents a graph node as a Long identifier
* - Edge: represents a directed connection between two vertices
* - PageRank: represents a vertex with its computed PageRank score
*
* These types support graph analytics operations within Wayang's
* cross-platform execution model.
*/
package object graph {

/**
* TODO: add the description for the implicitis in org.apache.wayang.api.graph
* labels: documentation,todo
*/

type Vertex = java.lang.Long

type Edge = T2[Vertex, Vertex]
Expand Down