Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
GraphScope documentation
Logo

Overview

  • Introducing GraphScope
  • Getting Started
  • Loading Graphs
  • Graph Analytics Workloads
  • Graph Interactive Workloads
  • Graph Learning Workloads
  • Design of GraphScope
  • Positioning of GraphScope
  • Glossary
  • Frequently Asked Questions

Installation & Deployment

  • Install GraphScope on Local
  • Deploy on K8s Cluster
  • Deploy with Existing Vineyard Cluster
  • Persistent storage of graphs on the Kubernetes cluster
  • Deploy GraphScope with helm
  • Install GraphScope in offline environment

GraphScope Flex

  • Coordinator
    • Getting Started
    • Development guide
      • Dev and Test
      • Coordinator Python SDK Reference
    • Coordinator RESTFul API
  • GraphScope Interactive
    • Overview
    • Installation
    • Getting Started
    • Using Custom Graph
    • Stored Procedures
    • Configuration
    • Data Model
    • Data Import Configuration
    • Development guide
      • Dev and Test
      • Java SDK Reference
      • Python SDK Reference
      • Interactive RESTFul API
      • Create c++ Stored Procedures on GraphScope Interactive
    • Deployment
    • Glossary

Graph Analytical Engine

  • Getting Started
  • Deployment for GAE
  • Design of Analytical Engine
    • Overview and Architecture
    • Key Concepts
    • Vertex-Centric Model
    • Programming Model: PIE
    • Ingress: Incrementalize Graph Algorithms
    • Programming Model: FLASH
    • NetworkX Compatibility
    • Built-in Algorithms
    • Customized Algorithms
    • Performance Tuning
  • Guide and Examples
  • Dev and Test

Graph Interactive Engine

  • Getting Started
  • Standalone Deployment for GIE
  • Apache TinkerPop Ecosystem
    • GIE for Gremlin
    • Guide and Examples
    • Supported Gremlin Steps
    • FAQs for GIE Gremlin Usage
  • Neo4j Ecosystem
    • GIE for Cypher
    • Cypher Support
    • Using LLM as an Assistant in GIE
  • GOpt: A Graph-Native Query Optimization Framework
  • Graph Planner Interface by JNI and RESTful API
  • A Generic Benchmark Tool
  • Design of GIE
  • Dev and Test

Graph Learning Engine

  • Getting Started
  • Design of GLE
  • Graph Sampling
  • Guide and Examples
  • Dev and Test

Storage Engine

  • GRIN: Graph Retrieval INterface
  • Groot: Persistent Graph Store
  • In-memory immutable graphs on Vineyard
  • GraphAr: Standard Graph Data File Format
  • GART: Bridging the Gap between Relational OLTP and Graph Workloads

Troubleshooting & Utilities

  • How to Find logs
  • Command-line Utility gsctl
  • Error Codes

Development

  • Development Guide
  • Code Style Guide
  • How to Test
  • How to Contribute

Reference

  • Python API Reference
    • Session
      • graphscope.session
      • graphscope.get_default_session
      • graphscope.has_default_session
      • graphscope.set_option
      • graphscope.g
      • graphscope.gremlin
      • graphscope.graphlearn
    • Graph
    • Analytical App
      • graphscope.framework.app.load_app
    • Context
    • Selector
    • Operation
      • graphscope.framework.operation.Operation.__init__
      • graphscope.framework.operation.Operation.as_op_def
      • graphscope.framework.operation.Operation.key
      • graphscope.framework.operation.Operation.signature
      • graphscope.framework.operation.Operation.eval
      • graphscope.framework.operation.Operation.evaluated
      • graphscope.framework.dag_utils.create_app
      • graphscope.framework.dag_utils.bind_app
      • graphscope.framework.dag_utils.run_app
      • graphscope.framework.dag_utils.create_graph
      • graphscope.framework.dag_utils.create_loader
      • graphscope.framework.dag_utils.add_labels_to_graph
      • graphscope.framework.dag_utils.dynamic_to_arrow
      • graphscope.framework.dag_utils.arrow_to_dynamic
      • graphscope.framework.dag_utils.modify_edges
      • graphscope.framework.dag_utils.modify_vertices
      • graphscope.framework.dag_utils.report_graph
      • graphscope.framework.dag_utils.project_arrow_property_graph
      • graphscope.framework.dag_utils.project_to_simple
      • graphscope.framework.dag_utils.copy_graph
      • graphscope.framework.dag_utils.to_directed
      • graphscope.framework.dag_utils.to_undirected
      • graphscope.framework.dag_utils.create_graph_view
      • graphscope.framework.dag_utils.clear_graph
      • graphscope.framework.dag_utils.clear_edges
      • graphscope.framework.dag_utils.create_subgraph
      • graphscope.framework.dag_utils.create_unload_op
      • graphscope.framework.dag_utils.unload_app
      • graphscope.framework.dag_utils.unload_graph
      • graphscope.framework.dag_utils.unload_context
      • graphscope.framework.dag_utils.context_to_numpy
      • graphscope.framework.dag_utils.context_to_dataframe
      • graphscope.framework.dag_utils.to_vineyard_tensor
      • graphscope.framework.dag_utils.to_vineyard_dataframe
      • graphscope.framework.dag_utils.to_data_sink
      • graphscope.framework.dag_utils.output
      • graphscope.framework.dag_utils.get_context_data
      • graphscope.framework.dag_utils.add_column
      • graphscope.framework.dag_utils.graph_to_numpy
      • graphscope.framework.dag_utils.graph_to_dataframe
      • graphscope.framework.dag_utils.gremlin_to_subgraph
    • Cython SDK API
      • graphscope.Vertex
      • graphscope.declare
    • Interactive Query
    • Graph Learning
    • NetworkX-style API
      • Graph types
      • Graph Transformation
      • Builtin algorithms
      • Functions
        • graphscope.nx.classes.function.degree
        • graphscope.nx.classes.function.degree_histogram
        • graphscope.nx.classes.function.density
        • graphscope.nx.classes.function.info
        • graphscope.nx.classes.function.create_empty_copy
        • graphscope.nx.classes.function.is_directed
        • graphscope.nx.classes.function.to_directed
        • graphscope.nx.classes.function.to_undirected
        • graphscope.nx.classes.function.is_empty
        • graphscope.nx.classes.function.add_star
        • graphscope.nx.classes.function.add_path
        • graphscope.nx.classes.function.add_cycle
        • graphscope.nx.classes.function.subgraph
        • graphscope.nx.classes.function.induced_subgraph
        • graphscope.nx.classes.function.edge_subgraph
        • graphscope.nx.classes.function.nodes
        • graphscope.nx.classes.function.number_of_nodes
        • graphscope.nx.classes.function.neighbors
        • graphscope.nx.classes.function.all_neighbors
        • graphscope.nx.classes.function.non_neighbors
        • graphscope.nx.classes.function.common_neighbors
        • graphscope.nx.classes.function.edges
        • graphscope.nx.classes.function.number_of_edges
        • graphscope.nx.classes.function.density
        • graphscope.nx.classes.function.non_edges
        • graphscope.nx.classes.function.selfloop_edges
        • graphscope.nx.classes.function.number_of_selfloops
        • graphscope.nx.classes.function.nodes_with_selfloops
        • graphscope.nx.classes.function.is_weighted
        • graphscope.nx.classes.function.is_negatively_weighted
        • graphscope.nx.classes.function.freeze
        • graphscope.nx.classes.function.is_frozen
      • Graph generators
        • graphscope.nx.generators.atlas.graph_atlas
        • graphscope.nx.generators.atlas.graph_atlas_g
        • graphscope.nx.generators.classic.balanced_tree
        • graphscope.nx.generators.classic.barbell_graph
        • graphscope.nx.generators.classic.binomial_tree
        • graphscope.nx.generators.classic.complete_graph
        • graphscope.nx.generators.classic.complete_multipartite_graph
        • graphscope.nx.generators.classic.circular_ladder_graph
        • graphscope.nx.generators.classic.circulant_graph
        • graphscope.nx.generators.classic.cycle_graph
        • graphscope.nx.generators.classic.dorogovtsev_goltsev_mendes_graph
        • graphscope.nx.generators.classic.empty_graph
        • graphscope.nx.generators.classic.path_graph
        • graphscope.nx.generators.classic.star_graph
        • graphscope.nx.generators.classic.full_rary_tree
        • graphscope.nx.generators.classic.ladder_graph
        • graphscope.nx.generators.classic.lollipop_graph
        • graphscope.nx.generators.classic.null_graph
        • graphscope.nx.generators.classic.trivial_graph
        • graphscope.nx.generators.classic.turan_graph
        • graphscope.nx.generators.classic.wheel_graph
        • graphscope.nx.generators.expanders.margulis_gabber_galil_graph
        • graphscope.nx.generators.expanders.chordal_cycle_graph
        • graphscope.nx.generators.expanders.paley_graph
        • graphscope.nx.generators.small.make_small_graph
        • graphscope.nx.generators.small.LCF_graph
        • graphscope.nx.generators.small.bull_graph
        • graphscope.nx.generators.small.chvatal_graph
        • graphscope.nx.generators.small.cubical_graph
        • graphscope.nx.generators.small.desargues_graph
        • graphscope.nx.generators.small.diamond_graph
        • graphscope.nx.generators.small.dodecahedral_graph
        • graphscope.nx.generators.small.frucht_graph
        • graphscope.nx.generators.small.heawood_graph
        • graphscope.nx.generators.small.house_graph
        • graphscope.nx.generators.small.house_x_graph
        • graphscope.nx.generators.small.icosahedral_graph
        • graphscope.nx.generators.small.krackhardt_kite_graph
        • graphscope.nx.generators.small.moebius_kantor_graph
        • graphscope.nx.generators.small.octahedral_graph
        • graphscope.nx.generators.small.pappus_graph
        • graphscope.nx.generators.small.petersen_graph
        • graphscope.nx.generators.small.sedgewick_maze_graph
        • graphscope.nx.generators.small.tetrahedral_graph
        • graphscope.nx.generators.small.truncated_cube_graph
        • graphscope.nx.generators.small.truncated_tetrahedron_graph
        • graphscope.nx.generators.small.tutte_graph
        • graphscope.nx.generators.duplication.duplication_divergence_graph
        • graphscope.nx.generators.duplication.partial_duplication_graph
        • graphscope.nx.generators.degree_seq.configuration_model
        • graphscope.nx.generators.degree_seq.directed_configuration_model
        • graphscope.nx.generators.degree_seq.expected_degree_graph
        • graphscope.nx.generators.degree_seq.havel_hakimi_graph
        • graphscope.nx.generators.degree_seq.directed_havel_hakimi_graph
        • graphscope.nx.generators.degree_seq.degree_sequence_tree
        • graphscope.nx.generators.degree_seq.random_degree_sequence_graph
        • graphscope.nx.generators.directed.gn_graph
        • graphscope.nx.generators.directed.gnr_graph
        • graphscope.nx.generators.directed.gnc_graph
        • graphscope.nx.generators.directed.random_k_out_graph
        • graphscope.nx.generators.directed.scale_free_graph
        • graphscope.nx.generators.geometric.random_geometric_graph
        • graphscope.nx.generators.geometric.soft_random_geometric_graph
        • graphscope.nx.generators.geometric.geographical_threshold_graph
        • graphscope.nx.generators.geometric.waxman_graph
        • graphscope.nx.generators.geometric.thresholded_random_geometric_graph
        • graphscope.nx.generators.ego.ego_graph
        • networkx.generators.stochastic.stochastic_graph
        • networkx.generators.internet_as_graphs.random_internet_as_graph
        • graphscope.nx.generators.intersection.uniform_random_intersection_graph
        • graphscope.nx.generators.intersection.k_random_intersection_graph
        • graphscope.nx.generators.intersection.general_random_intersection_graph
        • graphscope.nx.generators.social.karate_club_graph
        • graphscope.nx.generators.social.davis_southern_women_graph
        • graphscope.nx.generators.social.florentine_families_graph
        • graphscope.nx.generators.social.les_miserables_graph
        • graphscope.nx.generators.community.caveman_graph
        • graphscope.nx.generators.community.connected_caveman_graph
        • graphscope.nx.generators.community.gaussian_random_partition_graph
        • graphscope.nx.generators.community.LFR_benchmark_graph
        • graphscope.nx.generators.community.planted_partition_graph
        • graphscope.nx.generators.community.random_partition_graph
        • graphscope.nx.generators.community.relaxed_caveman_graph
        • graphscope.nx.generators.community.ring_of_cliques
        • graphscope.nx.generators.community.stochastic_block_model
        • graphscope.nx.generators.community.windmill_graph
        • graphscope.nx.generators.spectral_graph_forge.spectral_graph_forge
        • graphscope.nx.generators.trees.random_tree
        • graphscope.nx.generators.trees.prefix_tree
        • graphscope.nx.generators.nonisomorphic_trees.nonisomorphic_trees
        • graphscope.nx.generators.nonisomorphic_trees.number_of_nonisomorphic_trees
        • graphscope.nx.generators.triads.triad_graph
        • graphscope.nx.generators.joint_degree_seq.is_valid_joint_degree
        • graphscope.nx.generators.joint_degree_seq.joint_degree_graph
        • graphscope.nx.generators.joint_degree_seq.is_valid_directed_joint_degree
        • graphscope.nx.generators.joint_degree_seq.directed_joint_degree_graph
        • graphscope.nx.generators.mycielski.mycielskian
        • graphscope.nx.generators.mycielski.mycielski_graph
        • graphscope.nx.generators.harary_graph.hnm_harary_graph
        • graphscope.nx.generators.harary_graph.hkn_harary_graph
        • graphscope.nx.generators.sudoku.sudoku_graph
      • Reading graphs
  • Analytical Engine API Reference
  • Analytical Engine Java API Reference
  • Flex API Reference
Versions
latest
stable
v0.31.0
Languages
en
zh_CN
Hosted on Cloudflare Pages.
Back to top
Copyright © 2020-2023, DAMO Academy, Alibaba Inc.
Made with Sphinx and @pradyunsg's Furo