diff --git a/doc/.readthedocs.yaml b/doc/.readthedocs.yaml index 4467356..bf87a77 100644 --- a/doc/.readthedocs.yaml +++ b/doc/.readthedocs.yaml @@ -7,10 +7,16 @@ build: os: ubuntu-24.04 tools: python: "3.13" + jobs: + pre_install: + - pip install --no-deps dgf + build: + html: + - python -m mkdocs build -v --clean --site-dir $READTHEDOCS_OUTPUT/html --config-file doc/mkdocs.yml mkdocs: configuration: doc/mkdocs.yml python: install: - - requirements: doc/requirements.txt + - requirements: doc/requirements.txt \ No newline at end of file diff --git a/doc/docs/api.md b/doc/docs/api.md index a17f39c..a7a3169 100644 --- a/doc/docs/api.md +++ b/doc/docs/api.md @@ -28,10 +28,10 @@ Functions not yet part of the official API are available under `dgf.src.*`. Thos Utilities to analyze graphs, e.g., feature and graph statistics. -* [`dgf.analyse.feature_statistics`](api_details.md#section-dgf-analyse-feature-statistics): Computes the feature stats from a single graph. -* [`dgf.analyse.feature_statistics_from_graphs`](api_details.md#section-dgf-analyse-feature-statistics-from-graphs): Computes the feature stats from multiple graphs. -* [`dgf.analyse.padding_from_graph_generator`](api_details.md#section-dgf-analyse-padding-from-graph-generator): Creates a padding configuration from a set of in-memory graphs. -* [`dgf.analyse.print_schema`](api_details.md#section-dgf-analyse-print-schema): Generates a human-readable string representation of a graph schema. +* [`dgf.analyse.feature_statistics`](api/dgf-analyse.md#section-feature-statistics): Computes the feature stats from a single graph. +* [`dgf.analyse.feature_statistics_from_graphs`](api/dgf-analyse.md#section-feature-statistics-from-graphs): Computes the feature stats from multiple graphs. +* [`dgf.analyse.padding_from_graph_generator`](api/dgf-analyse.md#section-padding-from-graph-generator): Creates a padding configuration from a set of in-memory graphs. +* [`dgf.analyse.print_schema`](api/dgf-analyse.md#section-print-schema): Generates a human-readable string representation of a graph schema. @@ -40,24 +40,24 @@ Utilities to analyze graphs, e.g., feature and graph statistics. Converts object formats, e.g., a graph to a Sparse Deferred struct. -* [`dgf.convert.graph_dict_to_graph`](api_details.md#section-dgf-convert-graph-dict-to-graph): Converts a TF GNN Graph Sample Dict to an InMemoryGraph. -* [`dgf.convert.graph_to_jax_graph`](api_details.md#section-dgf-convert-graph-to-jax-graph): Converts a (NumPy) in-memory graph into a JAX in-memory graph. -* [`dgf.convert.graph_to_networkx`](api_details.md#section-dgf-convert-graph-to-networkx): Converts an InMemoryGraph into a NetworkX MultiDiGraph. -* [`dgf.convert.graph_to_serialized_tfgnn_graph`](api_details.md#section-dgf-convert-graph-to-serialized-tfgnn-graph): Converts an InMemoryGraph into a serialized TF-GNN graph sample proto. -* [`dgf.convert.graph_to_sparse_deferred_struct`](api_details.md#section-dgf-convert-graph-to-sparse-deferred-struct): Converts an in-memory graph into a Sparse Deferred struct. -* [`dgf.convert.graph_to_tf_graph`](api_details.md#section-dgf-convert-graph-to-tf-graph): Converts a graph to a TF in-memory graph. -* [`dgf.convert.graph_to_tfgnn_graph`](api_details.md#section-dgf-convert-graph-to-tfgnn-graph): Converts an InMemoryGraph to a TF GNN Graph Sample. -* [`dgf.convert.graph_to_tfgnn_graph_dict`](api_details.md#section-dgf-convert-graph-to-tfgnn-graph-dict): Converts an InMemoryGraph to a TF GNN Graph Sample Dict. -* [`dgf.convert.graphs_to_serialized_tfgnn_graphs`](api_details.md#section-dgf-convert-graphs-to-serialized-tfgnn-graphs): Converts a sequence of InMemoryGraphs into serialized TF-GNN graph sample protos. -* [`dgf.convert.networkx_to_graph`](api_details.md#section-dgf-convert-networkx-to-graph): Converts a NetworkX graph into an InMemoryGraph and its schema. -* [`dgf.convert.schema_to_spanner_ddl`](api_details.md#section-dgf-convert-schema-to-spanner-ddl): Converts a GraphSchema to a string of CREATE statements for Spanner. -* [`dgf.convert.schema_to_sparse_deferred_schema`](api_details.md#section-dgf-convert-schema-to-sparse-deferred-schema): Converts a DGF `GraphSchema` into a Sparse Deferred schema. -* [`dgf.convert.schema_to_tfgnn_schema`](api_details.md#section-dgf-convert-schema-to-tfgnn-schema): Converts a GraphSchema object into a TF-GNN schema proto. -* [`dgf.convert.sparse_deferred_struct_to_graph`](api_details.md#section-dgf-convert-sparse-deferred-struct-to-graph): Converts a Sparse Deferred struct into an in-memory graph. -* [`dgf.convert.tf_graph_dict_to_tf_graph`](api_details.md#section-dgf-convert-tf-graph-dict-to-tf-graph): Converts a flattened TFInMemoryGraphDict back into a TFInMemoryGraph. -* [`dgf.convert.tf_graph_to_tf_graph_dict`](api_details.md#section-dgf-convert-tf-graph-to-tf-graph-dict): Converts a TFInMemoryGraph into a flattened TFInMemoryGraphDict. -* [`dgf.convert.tfgnn_graph_to_graph`](api_details.md#section-dgf-convert-tfgnn-graph-to-graph): Converts a TF GNN Graph Sample to an InMemoryGraph. -* [`dgf.convert.tfgnn_schema_to_schema`](api_details.md#section-dgf-convert-tfgnn-schema-to-schema): Converts a TF-GNN schema proto into a GraphSchema object. +* [`dgf.convert.graph_dict_to_graph`](api/dgf-convert.md#section-graph-dict-to-graph): Converts a TF GNN Graph Sample Dict to an InMemoryGraph. +* [`dgf.convert.graph_to_jax_graph`](api/dgf-convert.md#section-graph-to-jax-graph): Converts a (NumPy) in-memory graph into a JAX in-memory graph. +* [`dgf.convert.graph_to_networkx`](api/dgf-convert.md#section-graph-to-networkx): Converts an InMemoryGraph into a NetworkX MultiDiGraph. +* [`dgf.convert.graph_to_serialized_tfgnn_graph`](api/dgf-convert.md#section-graph-to-serialized-tfgnn-graph): Converts an InMemoryGraph into a serialized TF-GNN graph sample proto. +* [`dgf.convert.graph_to_sparse_deferred_struct`](api/dgf-convert.md#section-graph-to-sparse-deferred-struct): Converts an in-memory graph into a Sparse Deferred struct. +* [`dgf.convert.graph_to_tf_graph`](api/dgf-convert.md#section-graph-to-tf-graph): Converts a graph to a TF in-memory graph. +* [`dgf.convert.graph_to_tfgnn_graph`](api/dgf-convert.md#section-graph-to-tfgnn-graph): Converts an InMemoryGraph to a TF GNN Graph Sample. +* [`dgf.convert.graph_to_tfgnn_graph_dict`](api/dgf-convert.md#section-graph-to-tfgnn-graph-dict): Converts an InMemoryGraph to a TF GNN Graph Sample Dict. +* [`dgf.convert.graphs_to_serialized_tfgnn_graphs`](api/dgf-convert.md#section-graphs-to-serialized-tfgnn-graphs): Converts a sequence of InMemoryGraphs into serialized TF-GNN graph sample protos. +* [`dgf.convert.networkx_to_graph`](api/dgf-convert.md#section-networkx-to-graph): Converts a NetworkX graph into an InMemoryGraph and its schema. +* [`dgf.convert.schema_to_spanner_ddl`](api/dgf-convert.md#section-schema-to-spanner-ddl): Converts a GraphSchema to a string of CREATE statements for Spanner. +* [`dgf.convert.schema_to_sparse_deferred_schema`](api/dgf-convert.md#section-schema-to-sparse-deferred-schema): Converts a DGF `GraphSchema` into a Sparse Deferred schema. +* [`dgf.convert.schema_to_tfgnn_schema`](api/dgf-convert.md#section-schema-to-tfgnn-schema): Converts a GraphSchema object into a TF-GNN schema proto. +* [`dgf.convert.sparse_deferred_struct_to_graph`](api/dgf-convert.md#section-sparse-deferred-struct-to-graph): Converts a Sparse Deferred struct into an in-memory graph. +* [`dgf.convert.tf_graph_dict_to_tf_graph`](api/dgf-convert.md#section-tf-graph-dict-to-tf-graph): Converts a flattened TFInMemoryGraphDict back into a TFInMemoryGraph. +* [`dgf.convert.tf_graph_to_tf_graph_dict`](api/dgf-convert.md#section-tf-graph-to-tf-graph-dict): Converts a TFInMemoryGraph into a flattened TFInMemoryGraphDict. +* [`dgf.convert.tfgnn_graph_to_graph`](api/dgf-convert.md#section-tfgnn-graph-to-graph): Converts a TF GNN Graph Sample to an InMemoryGraph. +* [`dgf.convert.tfgnn_schema_to_schema`](api/dgf-convert.md#section-tfgnn-schema-to-schema): Converts a TF-GNN schema proto into a GraphSchema object. @@ -66,29 +66,29 @@ Converts object formats, e.g., a graph to a Sparse Deferred struct. Classes that represent graph data. Contains no functions or algorithms. -* [`dgf.data.EdgeSchema`](api_details.md#section-dgf-data-edgeschema): EdgeSchema(source: str, target: str, features: Dict[str, dgf.src.data.schema.FeatureSchema] = ) -* [`dgf.data.EdgeSetPadding`](api_details.md#section-dgf-data-edgesetpadding): EdgeSetPadding(num_edges: int) -* [`dgf.data.FeatureFormat`](api_details.md#section-dgf-data-featureformat): How a value is represented / stored. -* [`dgf.data.FeatureSchema`](api_details.md#section-dgf-data-featureschema): Schema for a single feature. -* [`dgf.data.FeatureSemantic`](api_details.md#section-dgf-data-featuresemantic): How a value should be interpreted. -* [`dgf.data.FeatureSetStatistics`](api_details.md#section-dgf-data-featuresetstatistics): Statistics for a set of features. -* [`dgf.data.FeatureStatistics`](api_details.md#section-dgf-data-featurestatistics): Statistics for a feature. -* [`dgf.data.GraphFeatureStatistics`](api_details.md#section-dgf-data-graphfeaturestatistics): Statistics about the features in a graph. -* [`dgf.data.GraphSchema`](api_details.md#section-dgf-data-graphschema): GraphSchema(node_sets: Dict[str, dgf.src.data.schema.NodeSchema], edge_sets: Dict[str, dgf.src.data.schema.EdgeSchema]) -* [`dgf.data.GraphSchemaFilter`](api_details.md#section-dgf-data-graphschemafilter): Filters a GraphSchema to sub-select node sets, edge sets, and features. -* [`dgf.data.GraphSchemaV2`](api_details.md#section-dgf-data-graphschemav2): GraphSchema(node_sets: Dict[str, dgf.src.data.schema.NodeSchema], edge_sets: Dict[str, dgf.src.data.schema.EdgeSchema]) -* [`dgf.data.InMemoryEdgeSet`](api_details.md#section-dgf-data-inmemoryedgeset): An Edge Set. -* [`dgf.data.InMemoryGraph`](api_details.md#section-dgf-data-inmemorygraph): An in-memory generic graph. -* [`dgf.data.InMemoryNodeSet`](api_details.md#section-dgf-data-inmemorynodeset): A Node Set. -* [`dgf.data.JaxInMemoryEdgeSet`](api_details.md#section-dgf-data-jaxinmemoryedgeset): An Edge Set. -* [`dgf.data.JaxInMemoryGraph`](api_details.md#section-dgf-data-jaxinmemorygraph): An in-memory generic graph. -* [`dgf.data.JaxInMemoryNodeSet`](api_details.md#section-dgf-data-jaxinmemorynodeset): A Node Set. -* [`dgf.data.NodeSchema`](api_details.md#section-dgf-data-nodeschema): NodeSchema(features: Dict[str, dgf.src.data.schema.FeatureSchema] = ) -* [`dgf.data.NodeSetPadding`](api_details.md#section-dgf-data-nodesetpadding): NodeSetPadding(num_nodes: int) -* [`dgf.data.Padding`](api_details.md#section-dgf-data-padding): Information to pad a graph. -* [`dgf.data.TFInMemoryEdgeSet`](api_details.md#section-dgf-data-tfinmemoryedgeset): An Edge Set. -* [`dgf.data.TFInMemoryGraph`](api_details.md#section-dgf-data-tfinmemorygraph): An in-memory generic graph. -* [`dgf.data.TFInMemoryNodeSet`](api_details.md#section-dgf-data-tfinmemorynodeset): A Node Set. +* [`dgf.data.EdgeSchema`](api/dgf-data.md#section-edgeschema): EdgeSchema(source: str, target: str, features: Dict[str, dgf.src.data.schema.FeatureSchema] = ) +* [`dgf.data.EdgeSetPadding`](api/dgf-data.md#section-edgesetpadding): EdgeSetPadding(num_edges: int) +* [`dgf.data.FeatureFormat`](api/dgf-data.md#section-featureformat): How a value is represented / stored. +* [`dgf.data.FeatureSchema`](api/dgf-data.md#section-featureschema): Schema for a single feature. +* [`dgf.data.FeatureSemantic`](api/dgf-data.md#section-featuresemantic): How a value should be interpreted. +* [`dgf.data.FeatureSetStatistics`](api/dgf-data.md#section-featuresetstatistics): Statistics for a set of features. +* [`dgf.data.FeatureStatistics`](api/dgf-data.md#section-featurestatistics): Statistics for a feature. +* [`dgf.data.GraphFeatureStatistics`](api/dgf-data.md#section-graphfeaturestatistics): Statistics about the features in a graph. +* [`dgf.data.GraphSchema`](api/dgf-data.md#section-graphschema): GraphSchema(node_sets: Dict[str, dgf.src.data.schema.NodeSchema], edge_sets: Dict[str, dgf.src.data.schema.EdgeSchema]) +* [`dgf.data.GraphSchemaFilter`](api/dgf-data.md#section-graphschemafilter): Filters a GraphSchema to sub-select node sets, edge sets, and features. +* [`dgf.data.GraphSchemaV2`](api/dgf-data.md#section-graphschemav2): GraphSchema(node_sets: Dict[str, dgf.src.data.schema.NodeSchema], edge_sets: Dict[str, dgf.src.data.schema.EdgeSchema]) +* [`dgf.data.InMemoryEdgeSet`](api/dgf-data.md#section-inmemoryedgeset): An Edge Set. +* [`dgf.data.InMemoryGraph`](api/dgf-data.md#section-inmemorygraph): An in-memory generic graph. +* [`dgf.data.InMemoryNodeSet`](api/dgf-data.md#section-inmemorynodeset): A Node Set. +* [`dgf.data.JaxInMemoryEdgeSet`](api/dgf-data.md#section-jaxinmemoryedgeset): An Edge Set. +* [`dgf.data.JaxInMemoryGraph`](api/dgf-data.md#section-jaxinmemorygraph): An in-memory generic graph. +* [`dgf.data.JaxInMemoryNodeSet`](api/dgf-data.md#section-jaxinmemorynodeset): A Node Set. +* [`dgf.data.NodeSchema`](api/dgf-data.md#section-nodeschema): NodeSchema(features: Dict[str, dgf.src.data.schema.FeatureSchema] = ) +* [`dgf.data.NodeSetPadding`](api/dgf-data.md#section-nodesetpadding): NodeSetPadding(num_nodes: int) +* [`dgf.data.Padding`](api/dgf-data.md#section-padding): Information to pad a graph. +* [`dgf.data.TFInMemoryEdgeSet`](api/dgf-data.md#section-tfinmemoryedgeset): An Edge Set. +* [`dgf.data.TFInMemoryGraph`](api/dgf-data.md#section-tfinmemorygraph): An in-memory generic graph. +* [`dgf.data.TFInMemoryNodeSet`](api/dgf-data.md#section-tfinmemorynodeset): A Node Set. @@ -97,7 +97,7 @@ Classes that represent graph data. Contains no functions or algorithms. DGF-specific exceptions. -* [`dgf.exception.InsufficientPaddingError`](api_details.md#section-dgf-exception-insufficientpaddingerror): Inappropriate argument value (of correct type). +* [`dgf.exception.InsufficientPaddingError`](api/dgf-exception.md#section-insufficientpaddingerror): Inappropriate argument value (of correct type). @@ -106,15 +106,15 @@ DGF-specific exceptions. GraphFlow unified filesystem API. -* [`dgf.filesystem.create_gcs_bucket`](api_details.md#section-dgf-filesystem-create-gcs-bucket): Creates a GCS bucket. -* [`dgf.filesystem.exists`](api_details.md#section-dgf-filesystem-exists): Returns True if the path exists. -* [`dgf.filesystem.glob`](api_details.md#section-dgf-filesystem-glob): Returns a list of files and directories matching a pattern. -* [`dgf.filesystem.is_gcs_path`](api_details.md#section-dgf-filesystem-is-gcs-path): Returns True if the path is a Google Cloud Storage (GCS) path. -* [`dgf.filesystem.makedirs`](api_details.md#section-dgf-filesystem-makedirs): Creates directories if it does not exist. -* [`dgf.filesystem.open_read`](api_details.md#section-dgf-filesystem-open-read): Opens a file for reading and return a python file handle. -* [`dgf.filesystem.remove_paths`](api_details.md#section-dgf-filesystem-remove-paths): Removes all the files in parallel. -* [`dgf.filesystem.rename`](api_details.md#section-dgf-filesystem-rename): Renames (moves) a file or directory from old_path to new_path. -* [`dgf.filesystem.rmtree`](api_details.md#section-dgf-filesystem-rmtree): Recursively removes a directory and its contents. +* [`dgf.filesystem.create_gcs_bucket`](api/dgf-filesystem.md#section-create-gcs-bucket): Creates a GCS bucket. +* [`dgf.filesystem.exists`](api/dgf-filesystem.md#section-exists): Returns True if the path exists. +* [`dgf.filesystem.glob`](api/dgf-filesystem.md#section-glob): Returns a list of files and directories matching a pattern. +* [`dgf.filesystem.is_gcs_path`](api/dgf-filesystem.md#section-is-gcs-path): Returns True if the path is a Google Cloud Storage (GCS) path. +* [`dgf.filesystem.makedirs`](api/dgf-filesystem.md#section-makedirs): Creates directories if it does not exist. +* [`dgf.filesystem.open_read`](api/dgf-filesystem.md#section-open-read): Opens a file for reading and return a python file handle. +* [`dgf.filesystem.remove_paths`](api/dgf-filesystem.md#section-remove-paths): Removes all the files in parallel. +* [`dgf.filesystem.rename`](api/dgf-filesystem.md#section-rename): Renames (moves) a file or directory from old_path to new_path. +* [`dgf.filesystem.rmtree`](api/dgf-filesystem.md#section-rmtree): Recursively removes a directory and its contents. @@ -123,12 +123,12 @@ GraphFlow unified filesystem API. Tools to generate synthetic data. -* [`dgf.generate.EdgeNeighborGenerator`](api_details.md#section-dgf-generate-edgeneighborgenerator): Generates the idx of the positive and negative pairs of nodes. -* [`dgf.generate.RandomNegativeSampler`](api_details.md#section-dgf-generate-randomnegativesampler): Replace the target node with a random node. -* [`dgf.generate.RandomWalkNegativeSampler`](api_details.md#section-dgf-generate-randomwalknegativesampler): Replace the target node with a random walk generated node. -* [`dgf.generate.SyntheticGraphSampleConfig`](api_details.md#section-dgf-generate-syntheticgraphsampleconfig): Configuration for generating synthetic graph samples. -* [`dgf.generate.generate_synthetic_graph_sample`](api_details.md#section-dgf-generate-generate-synthetic-graph-sample): Generates a single synthetic graph sample based on a sampling plan. -* [`dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs`](api_details.md#section-dgf-generate-write-synthetic-graph-sample-as-tfgnn-graphs): Generates and writes synthetic graph samples as TF-GNN graphs. +* [`dgf.generate.EdgeNeighborGenerator`](api/dgf-generate.md#section-edgeneighborgenerator): Generates the idx of the positive and negative pairs of nodes. +* [`dgf.generate.RandomNegativeSampler`](api/dgf-generate.md#section-randomnegativesampler): Replace the target node with a random node. +* [`dgf.generate.RandomWalkNegativeSampler`](api/dgf-generate.md#section-randomwalknegativesampler): Replace the target node with a random walk generated node. +* [`dgf.generate.SyntheticGraphSampleConfig`](api/dgf-generate.md#section-syntheticgraphsampleconfig): Configuration for generating synthetic graph samples. +* [`dgf.generate.generate_synthetic_graph_sample`](api/dgf-generate.md#section-generate-synthetic-graph-sample): Generates a single synthetic graph sample based on a sampling plan. +* [`dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs`](api/dgf-generate.md#section-write-synthetic-graph-sample-as-tfgnn-graphs): Generates and writes synthetic graph samples as TF-GNN graphs. @@ -137,26 +137,26 @@ Tools to generate synthetic data. Functions to read and write graphs, schemas, and related data. -* [`dgf.io.cache`](api_details.md#section-dgf-io-cache): Returns and caches the variable(s) created by "create_fn". -* [`dgf.io.create_spanner_tables_from_graph_schema`](api_details.md#section-dgf-io-create-spanner-tables-from-graph-schema): Creates Spanner tables for a graph schema. -* [`dgf.io.export_bigquery_to_disk`](api_details.md#section-dgf-io-export-bigquery-to-disk): Reads a BigQuery Graph in-process and returns a GraphFlow in-memory graph. -* [`dgf.io.fetch_graphland_graph`](api_details.md#section-dgf-io-fetch-graphland-graph): Downloads and loads a Graphland dataset into memory. -* [`dgf.io.fetch_ogb_graph`](api_details.md#section-dgf-io-fetch-ogb-graph): Downloads and loads an OGB node property prediction dataset into memory. -* [`dgf.io.read_bigquery_graph`](api_details.md#section-dgf-io-read-bigquery-graph): Reads a BigQuery Graph in-process and returns a GraphFlow in-memory graph. -* [`dgf.io.read_bigquery_graph_schema`](api_details.md#section-dgf-io-read-bigquery-graph-schema): Reads the schema of a BigQuery graph into a GF schema. -* [`dgf.io.read_feature_statistics`](api_details.md#section-dgf-io-read-feature-statistics): Reads feature statistics from disk in a JSON format. -* [`dgf.io.read_graph`](api_details.md#section-dgf-io-read-graph): Reads a GF graph from a directory to an in-memory graph. -* [`dgf.io.read_graphai_hgraph`](api_details.md#section-dgf-io-read-graphai-hgraph): Reads an on-disk HGraph into an in-memory representation. -* [`dgf.io.read_schema`](api_details.md#section-dgf-io-read-schema): Loads graph schema from disk in a json format. -* [`dgf.io.read_spanner_graph`](api_details.md#section-dgf-io-read-spanner-graph): Reads a Spanner Graph in-process and returns a GraphFlow in-memory graph. -* [`dgf.io.read_spanner_graph_schema`](api_details.md#section-dgf-io-read-spanner-graph-schema): Reads the schema of a Spanner Graph. -* [`dgf.io.read_text_proto`](api_details.md#section-dgf-io-read-text-proto): Read a proto from disk in text format. -* [`dgf.io.read_tfgnn_graphs`](api_details.md#section-dgf-io-read-tfgnn-graphs): Reads a set of in-memory graphs from disk stored as TF Examples. -* [`dgf.io.write_feature_statistics`](api_details.md#section-dgf-io-write-feature-statistics): Saves feature statistics to disk in a json format. -* [`dgf.io.write_graph`](api_details.md#section-dgf-io-write-graph): Writes an in-memory graph and schema to a GF Graph directory. -* [`dgf.io.write_schema`](api_details.md#section-dgf-io-write-schema): Saves graph schema to disk in a json format. -* [`dgf.io.write_text_proto`](api_details.md#section-dgf-io-write-text-proto): Writes a proto to disk in text format. -* [`dgf.io.write_tfgnn_graphs`](api_details.md#section-dgf-io-write-tfgnn-graphs): Writes a set of in-memory graphs to disk as TF Examples. +* [`dgf.io.cache`](api/dgf-io.md#section-cache): Returns and caches the variable(s) created by "create_fn". +* [`dgf.io.create_spanner_tables_from_graph_schema`](api/dgf-io.md#section-create-spanner-tables-from-graph-schema): Creates Spanner tables for a graph schema. +* [`dgf.io.export_bigquery_to_disk`](api/dgf-io.md#section-export-bigquery-to-disk): Reads a BigQuery Graph in-process and returns a GraphFlow in-memory graph. +* [`dgf.io.fetch_graphland_graph`](api/dgf-io.md#section-fetch-graphland-graph): Downloads and loads a Graphland dataset into memory. +* [`dgf.io.fetch_ogb_graph`](api/dgf-io.md#section-fetch-ogb-graph): Downloads and loads an OGB node property prediction dataset into memory. +* [`dgf.io.read_bigquery_graph`](api/dgf-io.md#section-read-bigquery-graph): Reads a BigQuery Graph in-process and returns a GraphFlow in-memory graph. +* [`dgf.io.read_bigquery_graph_schema`](api/dgf-io.md#section-read-bigquery-graph-schema): Reads the schema of a BigQuery graph into a GF schema. +* [`dgf.io.read_feature_statistics`](api/dgf-io.md#section-read-feature-statistics): Reads feature statistics from disk in a JSON format. +* [`dgf.io.read_graph`](api/dgf-io.md#section-read-graph): Reads a GF graph from a directory to an in-memory graph. +* [`dgf.io.read_graphai_hgraph`](api/dgf-io.md#section-read-graphai-hgraph): Reads an on-disk HGraph into an in-memory representation. +* [`dgf.io.read_schema`](api/dgf-io.md#section-read-schema): Loads graph schema from disk in a json format. +* [`dgf.io.read_spanner_graph`](api/dgf-io.md#section-read-spanner-graph): Reads a Spanner Graph in-process and returns a GraphFlow in-memory graph. +* [`dgf.io.read_spanner_graph_schema`](api/dgf-io.md#section-read-spanner-graph-schema): Reads the schema of a Spanner Graph. +* [`dgf.io.read_text_proto`](api/dgf-io.md#section-read-text-proto): Read a proto from disk in text format. +* [`dgf.io.read_tfgnn_graphs`](api/dgf-io.md#section-read-tfgnn-graphs): Reads a set of in-memory graphs from disk stored as TF Examples. +* [`dgf.io.write_feature_statistics`](api/dgf-io.md#section-write-feature-statistics): Saves feature statistics to disk in a json format. +* [`dgf.io.write_graph`](api/dgf-io.md#section-write-graph): Writes an in-memory graph and schema to a GF Graph directory. +* [`dgf.io.write_schema`](api/dgf-io.md#section-write-schema): Saves graph schema to disk in a json format. +* [`dgf.io.write_text_proto`](api/dgf-io.md#section-write-text-proto): Writes a proto to disk in text format. +* [`dgf.io.write_tfgnn_graphs`](api/dgf-io.md#section-write-tfgnn-graphs): Writes a set of in-memory graphs to disk as TF Examples. @@ -165,47 +165,47 @@ Functions to read and write graphs, schemas, and related data. Machine Learning and Graph Neural Networks using JAX. -* [`dgf.jax.JaxBaseConfig`](api_details.md#section-dgf-jax-jaxbaseconfig): Base class for a GNN implemented in JAX. -* [`dgf.jax.get_activation`](api_details.md#section-dgf-jax-get-activation): Get an activation function by (string) name. -* [`dgf.jax.jnp_dtype_from_string`](api_details.md#section-dgf-jax-jnp-dtype-from-string): Return a JAX numpy type from a string name. -* [`dgf.jax.jnp_name_from_dtype`](api_details.md#section-dgf-jax-jnp-name-from-dtype): Return a string name for a jnp.dtype object. -* [`dgf.jax.train`](api_details.md#section-dgf-jax-train): Trains a Flax module with a flexible and feature-rich training loop. +* [`dgf.jax.JaxBaseConfig`](api/dgf-jax.md#section-jaxbaseconfig): Base class for a GNN implemented in JAX. +* [`dgf.jax.get_activation`](api/dgf-jax.md#section-get-activation): Get an activation function by (string) name. +* [`dgf.jax.jnp_dtype_from_string`](api/dgf-jax.md#section-jnp-dtype-from-string): Return a JAX numpy type from a string name. +* [`dgf.jax.jnp_name_from_dtype`](api/dgf-jax.md#section-jnp-name-from-dtype): Return a string name for a jnp.dtype object. +* [`dgf.jax.train`](api/dgf-jax.md#section-train): Trains a Flax module with a flexible and feature-rich training loop. #### Module `dgf.jax.layers` # {: #section-dgf-jax-layers} Flax modules implementing low level GNN operations. -* [`dgf.jax.layers.ClassificationHead`](api_details.md#section-dgf-jax-layers-classificationhead): Simple classification head. -* [`dgf.jax.layers.ClassificationHeadConfig`](api_details.md#section-dgf-jax-layers-classificationheadconfig): Configuration for a classification head. -* [`dgf.jax.layers.ConditionalGIN`](api_details.md#section-dgf-jax-layers-conditionalgin): Conditional GIN with a labeling trick: https://arxiv.org/abs/2106.06935. -* [`dgf.jax.layers.EmbedAndHomogenizeGraph`](api_details.md#section-dgf-jax-layers-embedandhomogenizegraph): Convert a heterogeneous graph into a homogeneous one. -* [`dgf.jax.layers.EmbedAndHomogenizeGraphConfig`](api_details.md#section-dgf-jax-layers-embedandhomogenizegraphconfig): Config for EmbedAndHomogenizeGraph. -* [`dgf.jax.layers.EmbedFeatureSet`](api_details.md#section-dgf-jax-layers-embedfeatureset): Computes a fixed sized dense embedding for a set of feature values. -* [`dgf.jax.layers.EmbedFeatureSetConfig`](api_details.md#section-dgf-jax-layers-embedfeaturesetconfig): Configuration for the EmbedFeatureSet layer. -* [`dgf.jax.layers.EmbedGraph`](api_details.md#section-dgf-jax-layers-embedgraph): Compute a fixed sized dense embedding for all the features in a graph. -* [`dgf.jax.layers.EmbedGraphConfig`](api_details.md#section-dgf-jax-layers-embedgraphconfig): Configuration for "EmbedGraph". -* [`dgf.jax.layers.GCN`](api_details.md#section-dgf-jax-layers-gcn): Graph convolutional network: https://arxiv.org/pdf/1609.02907.pdf. -* [`dgf.jax.layers.GCNConfig`](api_details.md#section-dgf-jax-layers-gcnconfig): Makeable GCN config class with sensible defaults. -* [`dgf.jax.layers.GIN`](api_details.md#section-dgf-jax-layers-gin): Graph isomorphism network: https://arxiv.org/pdf/1810.00826.pdf. -* [`dgf.jax.layers.GINConfig`](api_details.md#section-dgf-jax-layers-ginconfig): Makeable GIN config class with sensible defaults. -* [`dgf.jax.layers.GenericBlock`](api_details.md#section-dgf-jax-layers-genericblock): A generic configurable neural network block. -* [`dgf.jax.layers.GenericBlockConfig`](api_details.md#section-dgf-jax-layers-genericblockconfig): Configuration for a generic block parsed from a string. -* [`dgf.jax.layers.HeterogeneousGraphAttentionNetwork`](api_details.md#section-dgf-jax-layers-heterogeneousgraphattentionnetwork): A single layer of heterogeneous Graph Attention Network. -* [`dgf.jax.layers.HeterogeneousGraphAttentionNetworkConfig`](api_details.md#section-dgf-jax-layers-heterogeneousgraphattentionnetworkconfig): Configuration for HeterogeneousGraphAttentionNetwork. -* [`dgf.jax.layers.HeterogeneousGraphConvolution`](api_details.md#section-dgf-jax-layers-heterogeneousgraphconvolution): A single layer of heterogeneous Graph Neural Network message passing. -* [`dgf.jax.layers.HeterogeneousGraphConvolutionConfig`](api_details.md#section-dgf-jax-layers-heterogeneousgraphconvolutionconfig): Configuration for HeterogeneousGraphConvolution. -* [`dgf.jax.layers.MLP`](api_details.md#section-dgf-jax-layers-mlp): A generic MLP followed by a linear layer. -* [`dgf.jax.layers.MPNN`](api_details.md#section-dgf-jax-layers-mpnn): Message-Passing Neural Network: https://arxiv.org/abs/1704.01212. -* [`dgf.jax.layers.MPNNConfig`](api_details.md#section-dgf-jax-layers-mpnnconfig): Makeable MPNN config class with sensible defaults. -* [`dgf.jax.layers.Projector`](api_details.md#section-dgf-jax-layers-projector): Simple wrapper around the generic MLP layer for graph input/output. -* [`dgf.jax.layers.ProjectorConfig`](api_details.md#section-dgf-jax-layers-projectorconfig): Makeable Projector config class with sensible defaults. -* [`dgf.jax.layers.ResidualMLPV2`](api_details.md#section-dgf-jax-layers-residualmlpv2): A residual MLP layer. See ResidualMLPV2Config. -* [`dgf.jax.layers.ResidualMLPV2Config`](api_details.md#section-dgf-jax-layers-residualmlpv2config): A residual MLP layer. -* [`dgf.jax.layers.identity`](api_details.md#section-dgf-jax-layers-identity): Returns a GenericBlockConfig that acts as an identity block. -* [`dgf.jax.layers.ingest_feature`](api_details.md#section-dgf-jax-layers-ingest-feature): Returns a GenericBlockConfig for feature ingestion. -* [`dgf.jax.layers.modern_residual_mlp`](api_details.md#section-dgf-jax-layers-modern-residual-mlp): Returns a GenericBlockConfig for a modern residual MLP. -* [`dgf.jax.layers.sequential_mlp`](api_details.md#section-dgf-jax-layers-sequential-mlp): Returns a GenericBlockConfig for a sequential MLP. +* [`dgf.jax.layers.ClassificationHead`](api/dgf-jax-layers.md#section-classificationhead): Simple classification head. +* [`dgf.jax.layers.ClassificationHeadConfig`](api/dgf-jax-layers.md#section-classificationheadconfig): Configuration for a classification head. +* [`dgf.jax.layers.ConditionalGIN`](api/dgf-jax-layers.md#section-conditionalgin): Conditional GIN with a labeling trick: https://arxiv.org/abs/2106.06935. +* [`dgf.jax.layers.EmbedAndHomogenizeGraph`](api/dgf-jax-layers.md#section-embedandhomogenizegraph): Convert a heterogeneous graph into a homogeneous one. +* [`dgf.jax.layers.EmbedAndHomogenizeGraphConfig`](api/dgf-jax-layers.md#section-embedandhomogenizegraphconfig): Config for EmbedAndHomogenizeGraph. +* [`dgf.jax.layers.EmbedFeatureSet`](api/dgf-jax-layers.md#section-embedfeatureset): Computes a fixed sized dense embedding for a set of feature values. +* [`dgf.jax.layers.EmbedFeatureSetConfig`](api/dgf-jax-layers.md#section-embedfeaturesetconfig): Configuration for the EmbedFeatureSet layer. +* [`dgf.jax.layers.EmbedGraph`](api/dgf-jax-layers.md#section-embedgraph): Compute a fixed sized dense embedding for all the features in a graph. +* [`dgf.jax.layers.EmbedGraphConfig`](api/dgf-jax-layers.md#section-embedgraphconfig): Configuration for "EmbedGraph". +* [`dgf.jax.layers.GCN`](api/dgf-jax-layers.md#section-gcn): Graph convolutional network: https://arxiv.org/pdf/1609.02907.pdf. +* [`dgf.jax.layers.GCNConfig`](api/dgf-jax-layers.md#section-gcnconfig): Makeable GCN config class with sensible defaults. +* [`dgf.jax.layers.GIN`](api/dgf-jax-layers.md#section-gin): Graph isomorphism network: https://arxiv.org/pdf/1810.00826.pdf. +* [`dgf.jax.layers.GINConfig`](api/dgf-jax-layers.md#section-ginconfig): Makeable GIN config class with sensible defaults. +* [`dgf.jax.layers.GenericBlock`](api/dgf-jax-layers.md#section-genericblock): A generic configurable neural network block. +* [`dgf.jax.layers.GenericBlockConfig`](api/dgf-jax-layers.md#section-genericblockconfig): Configuration for a generic block parsed from a string. +* [`dgf.jax.layers.HeterogeneousGraphAttentionNetwork`](api/dgf-jax-layers.md#section-heterogeneousgraphattentionnetwork): A single layer of heterogeneous Graph Attention Network. +* [`dgf.jax.layers.HeterogeneousGraphAttentionNetworkConfig`](api/dgf-jax-layers.md#section-heterogeneousgraphattentionnetworkconfig): Configuration for HeterogeneousGraphAttentionNetwork. +* [`dgf.jax.layers.HeterogeneousGraphConvolution`](api/dgf-jax-layers.md#section-heterogeneousgraphconvolution): A single layer of heterogeneous Graph Neural Network message passing. +* [`dgf.jax.layers.HeterogeneousGraphConvolutionConfig`](api/dgf-jax-layers.md#section-heterogeneousgraphconvolutionconfig): Configuration for HeterogeneousGraphConvolution. +* [`dgf.jax.layers.MLP`](api/dgf-jax-layers.md#section-mlp): A generic MLP followed by a linear layer. +* [`dgf.jax.layers.MPNN`](api/dgf-jax-layers.md#section-mpnn): Message-Passing Neural Network: https://arxiv.org/abs/1704.01212. +* [`dgf.jax.layers.MPNNConfig`](api/dgf-jax-layers.md#section-mpnnconfig): Makeable MPNN config class with sensible defaults. +* [`dgf.jax.layers.Projector`](api/dgf-jax-layers.md#section-projector): Simple wrapper around the generic MLP layer for graph input/output. +* [`dgf.jax.layers.ProjectorConfig`](api/dgf-jax-layers.md#section-projectorconfig): Makeable Projector config class with sensible defaults. +* [`dgf.jax.layers.ResidualMLPV2`](api/dgf-jax-layers.md#section-residualmlpv2): A residual MLP layer. See ResidualMLPV2Config. +* [`dgf.jax.layers.ResidualMLPV2Config`](api/dgf-jax-layers.md#section-residualmlpv2config): A residual MLP layer. +* [`dgf.jax.layers.identity`](api/dgf-jax-layers.md#section-identity): Returns a GenericBlockConfig that acts as an identity block. +* [`dgf.jax.layers.ingest_feature`](api/dgf-jax-layers.md#section-ingest-feature): Returns a GenericBlockConfig for feature ingestion. +* [`dgf.jax.layers.modern_residual_mlp`](api/dgf-jax-layers.md#section-modern-residual-mlp): Returns a GenericBlockConfig for a modern residual MLP. +* [`dgf.jax.layers.sequential_mlp`](api/dgf-jax-layers.md#section-sequential-mlp): Returns a GenericBlockConfig for a sequential MLP. @@ -216,12 +216,12 @@ Flax modules implementing low level GNN operations. Top-level learning module. -* [`dgf.learning.LinkPredictionModel`](api_details.md#section-dgf-learning-linkpredictionmodel): The user-visible returned model object for edge prediction. -* [`dgf.learning.Model`](api_details.md#section-dgf-learning-model): A generic model from the 10-lines of code API. -* [`dgf.learning.NodePredictionModel`](api_details.md#section-dgf-learning-nodepredictionmodel): The user-visible returned model object. -* [`dgf.learning.load_model`](api_details.md#section-dgf-learning-load-model): Loads a model previously saved with `model.save()`. -* [`dgf.learning.train_link_model`](api_details.md#section-dgf-learning-train-link-model): Trains a supervised Graph Neural Network model for edge prediction. -* [`dgf.learning.train_node_model`](api_details.md#section-dgf-learning-train-node-model): Trains a supervised Graph Neural Network model for node-level prediction. +* [`dgf.learning.LinkPredictionModel`](api/dgf-learning.md#section-linkpredictionmodel): The user-visible returned model object for edge prediction. +* [`dgf.learning.Model`](api/dgf-learning.md#section-model): A generic model from the 10-lines of code API. +* [`dgf.learning.NodePredictionModel`](api/dgf-learning.md#section-nodepredictionmodel): The user-visible returned model object. +* [`dgf.learning.load_model`](api/dgf-learning.md#section-load-model): Loads a model previously saved with `model.save()`. +* [`dgf.learning.train_link_model`](api/dgf-learning.md#section-train-link-model): Trains a supervised Graph Neural Network model for edge prediction. +* [`dgf.learning.train_node_model`](api/dgf-learning.md#section-train-node-model): Trains a supervised Graph Neural Network model for node-level prediction. @@ -230,9 +230,9 @@ Top-level learning module. Functions to plot graphs, schemas, and other graph-related data. -* [`dgf.plot.plot_graph`](api_details.md#section-dgf-plot-plot-graph): Plots an in-memory graph. -* [`dgf.plot.plot_nx_graph`](api_details.md#section-dgf-plot-plot-nx-graph): Helper function to draw an nx graph. -* [`dgf.plot.plot_schema`](api_details.md#section-dgf-plot-plot-schema): Plots the graphschema's meta-graph (i.e., its nodesets and edgesets). +* [`dgf.plot.plot_graph`](api/dgf-plot.md#section-plot-graph): Plots an in-memory graph. +* [`dgf.plot.plot_nx_graph`](api/dgf-plot.md#section-plot-nx-graph): Helper function to draw an nx graph. +* [`dgf.plot.plot_schema`](api/dgf-plot.md#section-plot-schema): Plots the graphschema's meta-graph (i.e., its nodesets and edgesets). @@ -241,9 +241,9 @@ Functions to plot graphs, schemas, and other graph-related data. Functions for printing structures. -* [`dgf.print.padding`](api_details.md#section-dgf-print-padding): Generates a human-readable string representation of a graph padding. -* [`dgf.print.sampling_plan`](api_details.md#section-dgf-print-sampling-plan): Generates a human-readable tree representation of a sampling plan. -* [`dgf.print.schema`](api_details.md#section-dgf-print-schema): Generates a human-readable string representation of a graph schema. +* [`dgf.print.padding`](api/dgf-print.md#section-padding): Generates a human-readable string representation of a graph padding. +* [`dgf.print.sampling_plan`](api/dgf-print.md#section-sampling-plan): Generates a human-readable tree representation of a sampling plan. +* [`dgf.print.schema`](api/dgf-print.md#section-schema): Generates a human-readable string representation of a graph schema. @@ -252,16 +252,16 @@ Functions for printing structures. Functions and classes to extract subsets of graphs for GNN training. -* [`dgf.sampling.Sampler`](api_details.md#section-dgf-sampling-sampler): Sampler for generating subgraphs from an in-memory graph. -* [`dgf.sampling.SamplingPlan`](api_details.md#section-dgf-sampling-samplingplan): Defines a complex sampling config. -* [`dgf.sampling.SimpleSamplingConfig`](api_details.md#section-dgf-sampling-simplesamplingconfig): Configuration for simple neighborhood sampling. -* [`dgf.sampling.SpannerGraphSampler`](api_details.md#section-dgf-sampling-spannergraphsampler): Sampler that executes queries on Spanner directly to fetch subgraphs. -* [`dgf.sampling.create_graph_spanner_sampler`](api_details.md#section-dgf-sampling-create-graph-spanner-sampler): Creates a SpannerGraphSampler instance. -* [`dgf.sampling.create_sampler`](api_details.md#section-dgf-sampling-create-sampler): Creates an in-memory sampler. -* [`dgf.sampling.extract_beam_nodes_ids`](api_details.md#section-dgf-sampling-extract-beam-nodes-ids): Extracts all the node ids of a given nodeset. -* [`dgf.sampling.sample_with_beam_semi_distributed_sampler`](api_details.md#section-dgf-sampling-sample-with-beam-semi-distributed-sampler): Samples subgraphs from a distributed graph using a semi-distributed algo. -* [`dgf.sampling.sample_with_beam_semi_distributed_sampler_v2`](api_details.md#section-dgf-sampling-sample-with-beam-semi-distributed-sampler-v2): Samples subgraphs from a distributed graph using a semi-distributed algo. -* [`dgf.sampling.simple_sampling_config_to_sampling_plan`](api_details.md#section-dgf-sampling-simple-sampling-config-to-sampling-plan): Converts a SimpleSamplingConfig to a more general SamplingPlan. +* [`dgf.sampling.Sampler`](api/dgf-sampling.md#section-sampler): Sampler for generating subgraphs from an in-memory graph. +* [`dgf.sampling.SamplingPlan`](api/dgf-sampling.md#section-samplingplan): Defines a complex sampling config. +* [`dgf.sampling.SimpleSamplingConfig`](api/dgf-sampling.md#section-simplesamplingconfig): Configuration for simple neighborhood sampling. +* [`dgf.sampling.SpannerGraphSampler`](api/dgf-sampling.md#section-spannergraphsampler): Sampler that executes queries on Spanner directly to fetch subgraphs. +* [`dgf.sampling.create_graph_spanner_sampler`](api/dgf-sampling.md#section-create-graph-spanner-sampler): Creates a SpannerGraphSampler instance. +* [`dgf.sampling.create_sampler`](api/dgf-sampling.md#section-create-sampler): Creates an in-memory sampler. +* [`dgf.sampling.extract_beam_nodes_ids`](api/dgf-sampling.md#section-extract-beam-nodes-ids): Extracts all the node ids of a given nodeset. +* [`dgf.sampling.sample_with_beam_semi_distributed_sampler`](api/dgf-sampling.md#section-sample-with-beam-semi-distributed-sampler): Samples subgraphs from a distributed graph using a semi-distributed algo. +* [`dgf.sampling.sample_with_beam_semi_distributed_sampler_v2`](api/dgf-sampling.md#section-sample-with-beam-semi-distributed-sampler-v2): Samples subgraphs from a distributed graph using a semi-distributed algo. +* [`dgf.sampling.simple_sampling_config_to_sampling_plan`](api/dgf-sampling.md#section-simple-sampling-config-to-sampling-plan): Converts a SimpleSamplingConfig to a more general SamplingPlan. @@ -270,7 +270,7 @@ Functions and classes to extract subsets of graphs for GNN training. Functions and classes to train core GNN models. -* [`dgf.train.EmbedNodesetFeaturesModule`](api_details.md#section-dgf-train-embednodesetfeaturesmodule): A FLAX module to transform a set of features into a fixed-size embedding. +* [`dgf.train.EmbedNodesetFeaturesModule`](api/dgf-train.md#section-embednodesetfeaturesmodule): A FLAX module to transform a set of features into a fixed-size embedding. @@ -279,29 +279,29 @@ Functions and classes to train core GNN models. Transforms graph data into other graph structures or formats. -* [`dgf.transform.AutoNormalizeConfig`](api_details.md#section-dgf-transform-autonormalizeconfig): Configuration for automatic feature normalization for GNNs. -* [`dgf.transform.ContainsLabelPredicate`](api_details.md#section-dgf-transform-containslabelpredicate): Predicate for filtering subgraphs if they have a positive label. -* [`dgf.transform.DictionaryIndexNormalizer`](api_details.md#section-dgf-transform-dictionaryindexnormalizer): Normalizes features by mapping dictionary keys to their integer indices. -* [`dgf.transform.GNNDatasetPreparator`](api_details.md#section-dgf-transform-gnndatasetpreparator): Generates graph samples to train node prediction models. -* [`dgf.transform.GraphNormalizer`](api_details.md#section-dgf-transform-graphnormalizer): Applies a collection of individual AbstractFeatureNormalizer on a graph. -* [`dgf.transform.GraphNormalizerConfig`](api_details.md#section-dgf-transform-graphnormalizerconfig): Raw information of a GraphNormalizer for easy serialization. -* [`dgf.transform.IdentityNormalizer`](api_details.md#section-dgf-transform-identitynormalizer): A normalizer that simply pass a feature without changing it. -* [`dgf.transform.NumNodesPredicate`](api_details.md#section-dgf-transform-numnodespredicate): Predicate for filtering by number of nodes. -* [`dgf.transform.SoftQuantileNormalizer`](api_details.md#section-dgf-transform-softquantilenormalizer): Normalizes a numerical feature by replacing it with its soft quantile -0.5. -* [`dgf.transform.apply_feature`](api_details.md#section-dgf-transform-apply-feature): Applies feature processors to the node and edge sets of a graph. -* [`dgf.transform.auto_normalize`](api_details.md#section-dgf-transform-auto-normalize): Create a generally good GraphNormalizer from feature statistics. -* [`dgf.transform.batch_indices_generator`](api_details.md#section-dgf-transform-batch-indices-generator): Generates batches of indices. -* [`dgf.transform.drop_edge_features`](api_details.md#section-dgf-transform-drop-edge-features): Drops all edge features from a graph and its schema. -* [`dgf.transform.drop_edge_features_from_schema`](api_details.md#section-dgf-transform-drop-edge-features-from-schema): Drops all edge features from a schema. -* [`dgf.transform.filter_graph`](api_details.md#section-dgf-transform-filter-graph): Creates an in-memory graph with a subset of nodesets/edgesets/features. -* [`dgf.transform.filter_graphs`](api_details.md#section-dgf-transform-filter-graphs): Filters a sequence of graphs based on user defined predicates. -* [`dgf.transform.filter_schema`](api_details.md#section-dgf-transform-filter-schema): Extracts a subset of the nodesets/edgesets/features from a schema. -* [`dgf.transform.homogeneous_graph_piece_to_nx`](api_details.md#section-dgf-transform-homogeneous-graph-piece-to-nx): Convert InMemoryGraph to an nx.Graph object. -* [`dgf.transform.homogenize`](api_details.md#section-dgf-transform-homogenize): Homogenizes a heterogeneous graph into a homogeneous one. -* [`dgf.transform.merge_graphs`](api_details.md#section-dgf-transform-merge-graphs): Merges multiple `InMemoryGraph` instances into a single graph. -* [`dgf.transform.propagate_timestamp_to_edges`](api_details.md#section-dgf-transform-propagate-timestamp-to-edges): Propagates timestamps from nodes to edges. -* [`dgf.transform.remove_padding_sentinels`](api_details.md#section-dgf-transform-remove-padding-sentinels): Removes the sentinel nodes and edges added by `merge_graphs`. -* [`dgf.transform.table2graph`](api_details.md#section-dgf-transform-table2graph): Converts a table (dict of arrays or DataFrame) into an InMemoryGraph and Schema. +* [`dgf.transform.AutoNormalizeConfig`](api/dgf-transform.md#section-autonormalizeconfig): Configuration for automatic feature normalization for GNNs. +* [`dgf.transform.ContainsLabelPredicate`](api/dgf-transform.md#section-containslabelpredicate): Predicate for filtering subgraphs if they have a positive label. +* [`dgf.transform.DictionaryIndexNormalizer`](api/dgf-transform.md#section-dictionaryindexnormalizer): Normalizes features by mapping dictionary keys to their integer indices. +* [`dgf.transform.GNNDatasetPreparator`](api/dgf-transform.md#section-gnndatasetpreparator): Generates graph samples to train node prediction models. +* [`dgf.transform.GraphNormalizer`](api/dgf-transform.md#section-graphnormalizer): Applies a collection of individual AbstractFeatureNormalizer on a graph. +* [`dgf.transform.GraphNormalizerConfig`](api/dgf-transform.md#section-graphnormalizerconfig): Raw information of a GraphNormalizer for easy serialization. +* [`dgf.transform.IdentityNormalizer`](api/dgf-transform.md#section-identitynormalizer): A normalizer that simply pass a feature without changing it. +* [`dgf.transform.NumNodesPredicate`](api/dgf-transform.md#section-numnodespredicate): Predicate for filtering by number of nodes. +* [`dgf.transform.SoftQuantileNormalizer`](api/dgf-transform.md#section-softquantilenormalizer): Normalizes a numerical feature by replacing it with its soft quantile -0.5. +* [`dgf.transform.apply_feature`](api/dgf-transform.md#section-apply-feature): Applies feature processors to the node and edge sets of a graph. +* [`dgf.transform.auto_normalize`](api/dgf-transform.md#section-auto-normalize): Create a generally good GraphNormalizer from feature statistics. +* [`dgf.transform.batch_indices_generator`](api/dgf-transform.md#section-batch-indices-generator): Generates batches of indices. +* [`dgf.transform.drop_edge_features`](api/dgf-transform.md#section-drop-edge-features): Drops all edge features from a graph and its schema. +* [`dgf.transform.drop_edge_features_from_schema`](api/dgf-transform.md#section-drop-edge-features-from-schema): Drops all edge features from a schema. +* [`dgf.transform.filter_graph`](api/dgf-transform.md#section-filter-graph): Creates an in-memory graph with a subset of nodesets/edgesets/features. +* [`dgf.transform.filter_graphs`](api/dgf-transform.md#section-filter-graphs): Filters a sequence of graphs based on user defined predicates. +* [`dgf.transform.filter_schema`](api/dgf-transform.md#section-filter-schema): Extracts a subset of the nodesets/edgesets/features from a schema. +* [`dgf.transform.homogeneous_graph_piece_to_nx`](api/dgf-transform.md#section-homogeneous-graph-piece-to-nx): Convert InMemoryGraph to an nx.Graph object. +* [`dgf.transform.homogenize`](api/dgf-transform.md#section-homogenize): Homogenizes a heterogeneous graph into a homogeneous one. +* [`dgf.transform.merge_graphs`](api/dgf-transform.md#section-merge-graphs): Merges multiple `InMemoryGraph` instances into a single graph. +* [`dgf.transform.propagate_timestamp_to_edges`](api/dgf-transform.md#section-propagate-timestamp-to-edges): Propagates timestamps from nodes to edges. +* [`dgf.transform.remove_padding_sentinels`](api/dgf-transform.md#section-remove-padding-sentinels): Removes the sentinel nodes and edges added by `merge_graphs`. +* [`dgf.transform.table2graph`](api/dgf-transform.md#section-table2graph): Converts a table (dict of arrays or DataFrame) into an InMemoryGraph and Schema. @@ -310,7 +310,7 @@ Transforms graph data into other graph structures or formats. Functions to validate graph data. -* [`dgf.validate.validate_graph`](api_details.md#section-dgf-validate-validate-graph): Validates an in memory graph object. +* [`dgf.validate.validate_graph`](api/dgf-validate.md#section-validate-graph): Validates an in memory graph object. @@ -319,17 +319,17 @@ Functions to validate graph data. Apache Beam-related functions and classes. -* [`dgf.beam.program_started`](api_details.md#section-dgf-beam-program-started): Call this function at the beginning of all GraphFlow Beam jobs. -* [`dgf.beam.runner_from_name`](api_details.md#section-dgf-beam-runner-from-name): Returns a Beam runner based on the provided name. -* [`dgf.beam.runner_from_options`](api_details.md#section-dgf-beam-runner-from-options): Returns a Beam runner based on the provided options. +* [`dgf.beam.program_started`](api/dgf-beam.md#section-program-started): Call this function at the beginning of all GraphFlow Beam jobs. +* [`dgf.beam.runner_from_name`](api/dgf-beam.md#section-runner-from-name): Returns a Beam runner based on the provided name. +* [`dgf.beam.runner_from_options`](api/dgf-beam.md#section-runner-from-options): Returns a Beam runner based on the provided options. #### Module `dgf.beam.analyse` # {: #section-dgf-beam-analyse} Functions to analyze graphs using Beam, e.g., feature and graph statistics. -* [`dgf.beam.analyse.feature_statistics`](api_details.md#section-dgf-beam-analyse-feature-statistics): Computes the feature statistics for a distributed Graph. -* [`dgf.beam.analyse.feature_statistics_from_graphs`](api_details.md#section-dgf-beam-analyse-feature-statistics-from-graphs): Computes the feature statistics for a set of InMemoryGraphs. +* [`dgf.beam.analyse.feature_statistics`](api/dgf-beam-analyse.md#section-feature-statistics): Computes the feature statistics for a distributed Graph. +* [`dgf.beam.analyse.feature_statistics_from_graphs`](api/dgf-beam-analyse.md#section-feature-statistics-from-graphs): Computes the feature statistics for a set of InMemoryGraphs. @@ -338,12 +338,12 @@ Functions to analyze graphs using Beam, e.g., feature and graph statistics. Classes that represent graph data. Contains no functions or algorithms. -* [`dgf.beam.data.Edge`](api_details.md#section-dgf-beam-data-edge): A single flat edge. -* [`dgf.beam.data.Graph`](api_details.md#section-dgf-beam-data-graph): A (potentially distributed) heterogeneous graph. -* [`dgf.beam.data.HeterogeniousGraph`](api_details.md#section-dgf-beam-data-heterogeniousgraph): A (potentially distributed) heterogeneous graph. -* [`dgf.beam.data.HomogeneousGraph`](api_details.md#section-dgf-beam-data-homogeneousgraph): A (potentially distributed) homogeneous graph. -* [`dgf.beam.data.KeyedInMemoryGraph`](api_details.md#section-dgf-beam-data-keyedinmemorygraph): KeyedInMemoryGraph(key, graph) -* [`dgf.beam.data.Node`](api_details.md#section-dgf-beam-data-node): Node(id: bytes | int, features: Optional[Dict[str, numpy.ndarray]] = None) +* [`dgf.beam.data.Edge`](api/dgf-beam-data.md#section-edge): A single flat edge. +* [`dgf.beam.data.Graph`](api/dgf-beam-data.md#section-graph): A (potentially distributed) heterogeneous graph. +* [`dgf.beam.data.HeterogeniousGraph`](api/dgf-beam-data.md#section-heterogeniousgraph): A (potentially distributed) heterogeneous graph. +* [`dgf.beam.data.HomogeneousGraph`](api/dgf-beam-data.md#section-homogeneousgraph): A (potentially distributed) homogeneous graph. +* [`dgf.beam.data.KeyedInMemoryGraph`](api/dgf-beam-data.md#section-keyedinmemorygraph): KeyedInMemoryGraph(key, graph) +* [`dgf.beam.data.Node`](api/dgf-beam-data.md#section-node): Node(id: bytes | int, features: Optional[Dict[str, numpy.ndarray]] = None) @@ -352,19 +352,19 @@ Classes that represent graph data. Contains no functions or algorithms. Functions to read and write graphs, schemas, and related data using Beam. -* [`dgf.beam.io.CreateSpannerTables`](api_details.md#section-dgf-beam-io-createspannertables): Creates Spanner tables for a graph schema. -* [`dgf.beam.io.read_bigquery_graph`](api_details.md#section-dgf-beam-io-read-bigquery-graph): Read BigQuery Graph via Beam and return a distributed GraphFlow graph. -* [`dgf.beam.io.read_graph`](api_details.md#section-dgf-beam-io-read-graph): Reads a GF graph into a distributed graph. -* [`dgf.beam.io.read_graphai_hgraph`](api_details.md#section-dgf-beam-io-read-graphai-hgraph): Reads a distributed HGraph using Beam. -* [`dgf.beam.io.read_spanner_graph`](api_details.md#section-dgf-beam-io-read-spanner-graph): Read Spanner Graph via Beam and return a distributed GraphFlow graph. -* [`dgf.beam.io.read_tfgnn_graphs`](api_details.md#section-dgf-beam-io-read-tfgnn-graphs): Read a collection of TF GNN Graphs. -* [`dgf.beam.io.write_edge_set_to_spanner`](api_details.md#section-dgf-beam-io-write-edge-set-to-spanner): Writes an edge set to a Spanner table using SpannerInsertOrUpdate. -* [`dgf.beam.io.write_feature_statistics`](api_details.md#section-dgf-beam-io-write-feature-statistics): Writes a beam pcollection of feature statistics to disk in json format. -* [`dgf.beam.io.write_graph`](api_details.md#section-dgf-beam-io-write-graph): Writes a GF Graph from a distributed graph (beam). -* [`dgf.beam.io.write_graphai_hgraph`](api_details.md#section-dgf-beam-io-write-graphai-hgraph): Initializes the WriteToHGraph PTransform. -* [`dgf.beam.io.write_node_set_to_spanner`](api_details.md#section-dgf-beam-io-write-node-set-to-spanner): Writes a node set to a Spanner table using SpannerInsertOrUpdate. -* [`dgf.beam.io.write_spanner`](api_details.md#section-dgf-beam-io-write-spanner): Writes a heterogeneous graph to Spanner. -* [`dgf.beam.io.write_tfgnn_graphs`](api_details.md#section-dgf-beam-io-write-tfgnn-graphs): Writes a collection of TF Graph Samples on disk. +* [`dgf.beam.io.CreateSpannerTables`](api/dgf-beam-io.md#section-createspannertables): Creates Spanner tables for a graph schema. +* [`dgf.beam.io.read_bigquery_graph`](api/dgf-beam-io.md#section-read-bigquery-graph): Read BigQuery Graph via Beam and return a distributed GraphFlow graph. +* [`dgf.beam.io.read_graph`](api/dgf-beam-io.md#section-read-graph): Reads a GF graph into a distributed graph. +* [`dgf.beam.io.read_graphai_hgraph`](api/dgf-beam-io.md#section-read-graphai-hgraph): Reads a distributed HGraph using Beam. +* [`dgf.beam.io.read_spanner_graph`](api/dgf-beam-io.md#section-read-spanner-graph): Read Spanner Graph via Beam and return a distributed GraphFlow graph. +* [`dgf.beam.io.read_tfgnn_graphs`](api/dgf-beam-io.md#section-read-tfgnn-graphs): Read a collection of TF GNN Graphs. +* [`dgf.beam.io.write_edge_set_to_spanner`](api/dgf-beam-io.md#section-write-edge-set-to-spanner): Writes an edge set to a Spanner table using SpannerInsertOrUpdate. +* [`dgf.beam.io.write_feature_statistics`](api/dgf-beam-io.md#section-write-feature-statistics): Writes a beam pcollection of feature statistics to disk in json format. +* [`dgf.beam.io.write_graph`](api/dgf-beam-io.md#section-write-graph): Writes a GF Graph from a distributed graph (beam). +* [`dgf.beam.io.write_graphai_hgraph`](api/dgf-beam-io.md#section-write-graphai-hgraph): Initializes the WriteToHGraph PTransform. +* [`dgf.beam.io.write_node_set_to_spanner`](api/dgf-beam-io.md#section-write-node-set-to-spanner): Writes a node set to a Spanner table using SpannerInsertOrUpdate. +* [`dgf.beam.io.write_spanner`](api/dgf-beam-io.md#section-write-spanner): Writes a heterogeneous graph to Spanner. +* [`dgf.beam.io.write_tfgnn_graphs`](api/dgf-beam-io.md#section-write-tfgnn-graphs): Writes a collection of TF Graph Samples on disk. @@ -373,9 +373,9 @@ Functions to read and write graphs, schemas, and related data using Beam. Functions to extract subsets of graphs for GNN training using Beam. -* [`dgf.beam.sampling.extract_nodes_ids`](api_details.md#section-dgf-beam-sampling-extract-nodes-ids): Extracts all the node ids of a given nodeset. -* [`dgf.beam.sampling.semi_distributed_sampler_v1`](api_details.md#section-dgf-beam-sampling-semi-distributed-sampler-v1): Samples subgraphs from a distributed graph using a semi-distributed algo. -* [`dgf.beam.sampling.semi_distributed_sampler_v2`](api_details.md#section-dgf-beam-sampling-semi-distributed-sampler-v2): Samples subgraphs from a distributed graph using a semi-distributed algo. +* [`dgf.beam.sampling.extract_nodes_ids`](api/dgf-beam-sampling.md#section-extract-nodes-ids): Extracts all the node ids of a given nodeset. +* [`dgf.beam.sampling.semi_distributed_sampler_v1`](api/dgf-beam-sampling.md#section-semi-distributed-sampler-v1): Samples subgraphs from a distributed graph using a semi-distributed algo. +* [`dgf.beam.sampling.semi_distributed_sampler_v2`](api/dgf-beam-sampling.md#section-semi-distributed-sampler-v2): Samples subgraphs from a distributed graph using a semi-distributed algo. @@ -384,7 +384,7 @@ Functions to extract subsets of graphs for GNN training using Beam. Transforms graph data into other graph formats using Beam. -* [`dgf.beam.transform.reverse_edges`](api_details.md#section-dgf-beam-transform-reverse-edges): Reverse the direction of edges in a graph. +* [`dgf.beam.transform.reverse_edges`](api/dgf-beam-transform.md#section-reverse-edges): Reverse the direction of edges in a graph. diff --git a/doc/docs/api/dgf-analyse.md b/doc/docs/api/dgf-analyse.md new file mode 100644 index 0000000..d7d232b --- /dev/null +++ b/doc/docs/api/dgf-analyse.md @@ -0,0 +1,19 @@ +--- +hide: + - toc +--- + +# dgf.analyse + +## dgf.analyse.feature_statistics # {: #section-feature-statistics} +::: dgf.analyse.feature_statistics + +## dgf.analyse.feature_statistics_from_graphs # {: #section-feature-statistics-from-graphs} +::: dgf.analyse.feature_statistics_from_graphs + +## dgf.analyse.padding_from_graph_generator # {: #section-padding-from-graph-generator} +::: dgf.analyse.padding_from_graph_generator + +## dgf.analyse.print_schema # {: #section-print-schema} +::: dgf.analyse.print_schema + diff --git a/doc/docs/api/dgf-beam-analyse.md b/doc/docs/api/dgf-beam-analyse.md new file mode 100644 index 0000000..c3f73fa --- /dev/null +++ b/doc/docs/api/dgf-beam-analyse.md @@ -0,0 +1,13 @@ +--- +hide: + - toc +--- + +# dgf.beam.analyse + +## dgf.beam.analyse.feature_statistics # {: #section-feature-statistics} +::: dgf.beam.analyse.feature_statistics + +## dgf.beam.analyse.feature_statistics_from_graphs # {: #section-feature-statistics-from-graphs} +::: dgf.beam.analyse.feature_statistics_from_graphs + diff --git a/doc/docs/api/dgf-beam-data.md b/doc/docs/api/dgf-beam-data.md new file mode 100644 index 0000000..2a58863 --- /dev/null +++ b/doc/docs/api/dgf-beam-data.md @@ -0,0 +1,25 @@ +--- +hide: + - toc +--- + +# dgf.beam.data + +## dgf.beam.data.Edge # {: #section-edge} +::: dgf.beam.data.Edge + +## dgf.beam.data.Graph # {: #section-graph} +::: dgf.beam.data.Graph + +## dgf.beam.data.HeterogeniousGraph # {: #section-heterogeniousgraph} +::: dgf.beam.data.HeterogeniousGraph + +## dgf.beam.data.HomogeneousGraph # {: #section-homogeneousgraph} +::: dgf.beam.data.HomogeneousGraph + +## dgf.beam.data.KeyedInMemoryGraph # {: #section-keyedinmemorygraph} +::: dgf.beam.data.KeyedInMemoryGraph + +## dgf.beam.data.Node # {: #section-node} +::: dgf.beam.data.Node + diff --git a/doc/docs/api/dgf-beam-io.md b/doc/docs/api/dgf-beam-io.md new file mode 100644 index 0000000..4de53ba --- /dev/null +++ b/doc/docs/api/dgf-beam-io.md @@ -0,0 +1,46 @@ +--- +hide: + - toc +--- + +# dgf.beam.io + +## dgf.beam.io.CreateSpannerTables # {: #section-createspannertables} +::: dgf.beam.io.CreateSpannerTables + +## dgf.beam.io.read_bigquery_graph # {: #section-read-bigquery-graph} +::: dgf.beam.io.read_bigquery_graph + +## dgf.beam.io.read_graph # {: #section-read-graph} +::: dgf.beam.io.read_graph + +## dgf.beam.io.read_graphai_hgraph # {: #section-read-graphai-hgraph} +::: dgf.beam.io.read_graphai_hgraph + +## dgf.beam.io.read_spanner_graph # {: #section-read-spanner-graph} +::: dgf.beam.io.read_spanner_graph + +## dgf.beam.io.read_tfgnn_graphs # {: #section-read-tfgnn-graphs} +::: dgf.beam.io.read_tfgnn_graphs + +## dgf.beam.io.write_edge_set_to_spanner # {: #section-write-edge-set-to-spanner} +::: dgf.beam.io.write_edge_set_to_spanner + +## dgf.beam.io.write_feature_statistics # {: #section-write-feature-statistics} +::: dgf.beam.io.write_feature_statistics + +## dgf.beam.io.write_graph # {: #section-write-graph} +::: dgf.beam.io.write_graph + +## dgf.beam.io.write_graphai_hgraph # {: #section-write-graphai-hgraph} +::: dgf.beam.io.write_graphai_hgraph + +## dgf.beam.io.write_node_set_to_spanner # {: #section-write-node-set-to-spanner} +::: dgf.beam.io.write_node_set_to_spanner + +## dgf.beam.io.write_spanner # {: #section-write-spanner} +::: dgf.beam.io.write_spanner + +## dgf.beam.io.write_tfgnn_graphs # {: #section-write-tfgnn-graphs} +::: dgf.beam.io.write_tfgnn_graphs + diff --git a/doc/docs/api/dgf-beam-sampling.md b/doc/docs/api/dgf-beam-sampling.md new file mode 100644 index 0000000..3086ce0 --- /dev/null +++ b/doc/docs/api/dgf-beam-sampling.md @@ -0,0 +1,16 @@ +--- +hide: + - toc +--- + +# dgf.beam.sampling + +## dgf.beam.sampling.extract_nodes_ids # {: #section-extract-nodes-ids} +::: dgf.beam.sampling.extract_nodes_ids + +## dgf.beam.sampling.semi_distributed_sampler_v1 # {: #section-semi-distributed-sampler-v1} +::: dgf.beam.sampling.semi_distributed_sampler_v1 + +## dgf.beam.sampling.semi_distributed_sampler_v2 # {: #section-semi-distributed-sampler-v2} +::: dgf.beam.sampling.semi_distributed_sampler_v2 + diff --git a/doc/docs/api/dgf-beam-transform.md b/doc/docs/api/dgf-beam-transform.md new file mode 100644 index 0000000..2eae22f --- /dev/null +++ b/doc/docs/api/dgf-beam-transform.md @@ -0,0 +1,10 @@ +--- +hide: + - toc +--- + +# dgf.beam.transform + +## dgf.beam.transform.reverse_edges # {: #section-reverse-edges} +::: dgf.beam.transform.reverse_edges + diff --git a/doc/docs/api/dgf-beam.md b/doc/docs/api/dgf-beam.md new file mode 100644 index 0000000..c43792d --- /dev/null +++ b/doc/docs/api/dgf-beam.md @@ -0,0 +1,16 @@ +--- +hide: + - toc +--- + +# dgf.beam + +## dgf.beam.program_started # {: #section-program-started} +::: dgf.beam.program_started + +## dgf.beam.runner_from_name # {: #section-runner-from-name} +::: dgf.beam.runner_from_name + +## dgf.beam.runner_from_options # {: #section-runner-from-options} +::: dgf.beam.runner_from_options + diff --git a/doc/docs/api/dgf-convert.md b/doc/docs/api/dgf-convert.md new file mode 100644 index 0000000..9b471b8 --- /dev/null +++ b/doc/docs/api/dgf-convert.md @@ -0,0 +1,61 @@ +--- +hide: + - toc +--- + +# dgf.convert + +## dgf.convert.graph_dict_to_graph # {: #section-graph-dict-to-graph} +::: dgf.convert.graph_dict_to_graph + +## dgf.convert.graph_to_jax_graph # {: #section-graph-to-jax-graph} +::: dgf.convert.graph_to_jax_graph + +## dgf.convert.graph_to_networkx # {: #section-graph-to-networkx} +::: dgf.convert.graph_to_networkx + +## dgf.convert.graph_to_serialized_tfgnn_graph # {: #section-graph-to-serialized-tfgnn-graph} +::: dgf.convert.graph_to_serialized_tfgnn_graph + +## dgf.convert.graph_to_sparse_deferred_struct # {: #section-graph-to-sparse-deferred-struct} +::: dgf.convert.graph_to_sparse_deferred_struct + +## dgf.convert.graph_to_tf_graph # {: #section-graph-to-tf-graph} +::: dgf.convert.graph_to_tf_graph + +## dgf.convert.graph_to_tfgnn_graph # {: #section-graph-to-tfgnn-graph} +::: dgf.convert.graph_to_tfgnn_graph + +## dgf.convert.graph_to_tfgnn_graph_dict # {: #section-graph-to-tfgnn-graph-dict} +::: dgf.convert.graph_to_tfgnn_graph_dict + +## dgf.convert.graphs_to_serialized_tfgnn_graphs # {: #section-graphs-to-serialized-tfgnn-graphs} +::: dgf.convert.graphs_to_serialized_tfgnn_graphs + +## dgf.convert.networkx_to_graph # {: #section-networkx-to-graph} +::: dgf.convert.networkx_to_graph + +## dgf.convert.schema_to_spanner_ddl # {: #section-schema-to-spanner-ddl} +::: dgf.convert.schema_to_spanner_ddl + +## dgf.convert.schema_to_sparse_deferred_schema # {: #section-schema-to-sparse-deferred-schema} +::: dgf.convert.schema_to_sparse_deferred_schema + +## dgf.convert.schema_to_tfgnn_schema # {: #section-schema-to-tfgnn-schema} +::: dgf.convert.schema_to_tfgnn_schema + +## dgf.convert.sparse_deferred_struct_to_graph # {: #section-sparse-deferred-struct-to-graph} +::: dgf.convert.sparse_deferred_struct_to_graph + +## dgf.convert.tf_graph_dict_to_tf_graph # {: #section-tf-graph-dict-to-tf-graph} +::: dgf.convert.tf_graph_dict_to_tf_graph + +## dgf.convert.tf_graph_to_tf_graph_dict # {: #section-tf-graph-to-tf-graph-dict} +::: dgf.convert.tf_graph_to_tf_graph_dict + +## dgf.convert.tfgnn_graph_to_graph # {: #section-tfgnn-graph-to-graph} +::: dgf.convert.tfgnn_graph_to_graph + +## dgf.convert.tfgnn_schema_to_schema # {: #section-tfgnn-schema-to-schema} +::: dgf.convert.tfgnn_schema_to_schema + diff --git a/doc/docs/api/dgf-data.md b/doc/docs/api/dgf-data.md new file mode 100644 index 0000000..0e16b4d --- /dev/null +++ b/doc/docs/api/dgf-data.md @@ -0,0 +1,76 @@ +--- +hide: + - toc +--- + +# dgf.data + +## dgf.data.EdgeSchema # {: #section-edgeschema} +::: dgf.data.EdgeSchema + +## dgf.data.EdgeSetPadding # {: #section-edgesetpadding} +::: dgf.data.EdgeSetPadding + +## dgf.data.FeatureFormat # {: #section-featureformat} +::: dgf.data.FeatureFormat + +## dgf.data.FeatureSchema # {: #section-featureschema} +::: dgf.data.FeatureSchema + +## dgf.data.FeatureSemantic # {: #section-featuresemantic} +::: dgf.data.FeatureSemantic + +## dgf.data.FeatureSetStatistics # {: #section-featuresetstatistics} +::: dgf.data.FeatureSetStatistics + +## dgf.data.FeatureStatistics # {: #section-featurestatistics} +::: dgf.data.FeatureStatistics + +## dgf.data.GraphFeatureStatistics # {: #section-graphfeaturestatistics} +::: dgf.data.GraphFeatureStatistics + +## dgf.data.GraphSchema # {: #section-graphschema} +::: dgf.data.GraphSchema + +## dgf.data.GraphSchemaFilter # {: #section-graphschemafilter} +::: dgf.data.GraphSchemaFilter + +## dgf.data.GraphSchemaV2 # {: #section-graphschemav2} +::: dgf.data.GraphSchemaV2 + +## dgf.data.InMemoryEdgeSet # {: #section-inmemoryedgeset} +::: dgf.data.InMemoryEdgeSet + +## dgf.data.InMemoryGraph # {: #section-inmemorygraph} +::: dgf.data.InMemoryGraph + +## dgf.data.InMemoryNodeSet # {: #section-inmemorynodeset} +::: dgf.data.InMemoryNodeSet + +## dgf.data.JaxInMemoryEdgeSet # {: #section-jaxinmemoryedgeset} +::: dgf.data.JaxInMemoryEdgeSet + +## dgf.data.JaxInMemoryGraph # {: #section-jaxinmemorygraph} +::: dgf.data.JaxInMemoryGraph + +## dgf.data.JaxInMemoryNodeSet # {: #section-jaxinmemorynodeset} +::: dgf.data.JaxInMemoryNodeSet + +## dgf.data.NodeSchema # {: #section-nodeschema} +::: dgf.data.NodeSchema + +## dgf.data.NodeSetPadding # {: #section-nodesetpadding} +::: dgf.data.NodeSetPadding + +## dgf.data.Padding # {: #section-padding} +::: dgf.data.Padding + +## dgf.data.TFInMemoryEdgeSet # {: #section-tfinmemoryedgeset} +::: dgf.data.TFInMemoryEdgeSet + +## dgf.data.TFInMemoryGraph # {: #section-tfinmemorygraph} +::: dgf.data.TFInMemoryGraph + +## dgf.data.TFInMemoryNodeSet # {: #section-tfinmemorynodeset} +::: dgf.data.TFInMemoryNodeSet + diff --git a/doc/docs/api/dgf-exception.md b/doc/docs/api/dgf-exception.md new file mode 100644 index 0000000..634b2f3 --- /dev/null +++ b/doc/docs/api/dgf-exception.md @@ -0,0 +1,10 @@ +--- +hide: + - toc +--- + +# dgf.exception + +## dgf.exception.InsufficientPaddingError # {: #section-insufficientpaddingerror} +::: dgf.exception.InsufficientPaddingError + diff --git a/doc/docs/api/dgf-filesystem.md b/doc/docs/api/dgf-filesystem.md new file mode 100644 index 0000000..dbb2c33 --- /dev/null +++ b/doc/docs/api/dgf-filesystem.md @@ -0,0 +1,34 @@ +--- +hide: + - toc +--- + +# dgf.filesystem + +## dgf.filesystem.create_gcs_bucket # {: #section-create-gcs-bucket} +::: dgf.filesystem.create_gcs_bucket + +## dgf.filesystem.exists # {: #section-exists} +::: dgf.filesystem.exists + +## dgf.filesystem.glob # {: #section-glob} +::: dgf.filesystem.glob + +## dgf.filesystem.is_gcs_path # {: #section-is-gcs-path} +::: dgf.filesystem.is_gcs_path + +## dgf.filesystem.makedirs # {: #section-makedirs} +::: dgf.filesystem.makedirs + +## dgf.filesystem.open_read # {: #section-open-read} +::: dgf.filesystem.open_read + +## dgf.filesystem.remove_paths # {: #section-remove-paths} +::: dgf.filesystem.remove_paths + +## dgf.filesystem.rename # {: #section-rename} +::: dgf.filesystem.rename + +## dgf.filesystem.rmtree # {: #section-rmtree} +::: dgf.filesystem.rmtree + diff --git a/doc/docs/api/dgf-generate.md b/doc/docs/api/dgf-generate.md new file mode 100644 index 0000000..c91ecc9 --- /dev/null +++ b/doc/docs/api/dgf-generate.md @@ -0,0 +1,25 @@ +--- +hide: + - toc +--- + +# dgf.generate + +## dgf.generate.EdgeNeighborGenerator # {: #section-edgeneighborgenerator} +::: dgf.generate.EdgeNeighborGenerator + +## dgf.generate.RandomNegativeSampler # {: #section-randomnegativesampler} +::: dgf.generate.RandomNegativeSampler + +## dgf.generate.RandomWalkNegativeSampler # {: #section-randomwalknegativesampler} +::: dgf.generate.RandomWalkNegativeSampler + +## dgf.generate.SyntheticGraphSampleConfig # {: #section-syntheticgraphsampleconfig} +::: dgf.generate.SyntheticGraphSampleConfig + +## dgf.generate.generate_synthetic_graph_sample # {: #section-generate-synthetic-graph-sample} +::: dgf.generate.generate_synthetic_graph_sample + +## dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs # {: #section-write-synthetic-graph-sample-as-tfgnn-graphs} +::: dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs + diff --git a/doc/docs/api/dgf-io.md b/doc/docs/api/dgf-io.md new file mode 100644 index 0000000..de3a150 --- /dev/null +++ b/doc/docs/api/dgf-io.md @@ -0,0 +1,67 @@ +--- +hide: + - toc +--- + +# dgf.io + +## dgf.io.cache # {: #section-cache} +::: dgf.io.cache + +## dgf.io.create_spanner_tables_from_graph_schema # {: #section-create-spanner-tables-from-graph-schema} +::: dgf.io.create_spanner_tables_from_graph_schema + +## dgf.io.export_bigquery_to_disk # {: #section-export-bigquery-to-disk} +::: dgf.io.export_bigquery_to_disk + +## dgf.io.fetch_graphland_graph # {: #section-fetch-graphland-graph} +::: dgf.io.fetch_graphland_graph + +## dgf.io.fetch_ogb_graph # {: #section-fetch-ogb-graph} +::: dgf.io.fetch_ogb_graph + +## dgf.io.read_bigquery_graph # {: #section-read-bigquery-graph} +::: dgf.io.read_bigquery_graph + +## dgf.io.read_bigquery_graph_schema # {: #section-read-bigquery-graph-schema} +::: dgf.io.read_bigquery_graph_schema + +## dgf.io.read_feature_statistics # {: #section-read-feature-statistics} +::: dgf.io.read_feature_statistics + +## dgf.io.read_graph # {: #section-read-graph} +::: dgf.io.read_graph + +## dgf.io.read_graphai_hgraph # {: #section-read-graphai-hgraph} +::: dgf.io.read_graphai_hgraph + +## dgf.io.read_schema # {: #section-read-schema} +::: dgf.io.read_schema + +## dgf.io.read_spanner_graph # {: #section-read-spanner-graph} +::: dgf.io.read_spanner_graph + +## dgf.io.read_spanner_graph_schema # {: #section-read-spanner-graph-schema} +::: dgf.io.read_spanner_graph_schema + +## dgf.io.read_text_proto # {: #section-read-text-proto} +::: dgf.io.read_text_proto + +## dgf.io.read_tfgnn_graphs # {: #section-read-tfgnn-graphs} +::: dgf.io.read_tfgnn_graphs + +## dgf.io.write_feature_statistics # {: #section-write-feature-statistics} +::: dgf.io.write_feature_statistics + +## dgf.io.write_graph # {: #section-write-graph} +::: dgf.io.write_graph + +## dgf.io.write_schema # {: #section-write-schema} +::: dgf.io.write_schema + +## dgf.io.write_text_proto # {: #section-write-text-proto} +::: dgf.io.write_text_proto + +## dgf.io.write_tfgnn_graphs # {: #section-write-tfgnn-graphs} +::: dgf.io.write_tfgnn_graphs + diff --git a/doc/docs/api/dgf-jax-layers.md b/doc/docs/api/dgf-jax-layers.md new file mode 100644 index 0000000..75f810b --- /dev/null +++ b/doc/docs/api/dgf-jax-layers.md @@ -0,0 +1,97 @@ +--- +hide: + - toc +--- + +# dgf.jax.layers + +## dgf.jax.layers.ClassificationHead # {: #section-classificationhead} +::: dgf.jax.layers.ClassificationHead + +## dgf.jax.layers.ClassificationHeadConfig # {: #section-classificationheadconfig} +::: dgf.jax.layers.ClassificationHeadConfig + +## dgf.jax.layers.ConditionalGIN # {: #section-conditionalgin} +::: dgf.jax.layers.ConditionalGIN + +## dgf.jax.layers.EmbedAndHomogenizeGraph # {: #section-embedandhomogenizegraph} +::: dgf.jax.layers.EmbedAndHomogenizeGraph + +## dgf.jax.layers.EmbedAndHomogenizeGraphConfig # {: #section-embedandhomogenizegraphconfig} +::: dgf.jax.layers.EmbedAndHomogenizeGraphConfig + +## dgf.jax.layers.EmbedFeatureSet # {: #section-embedfeatureset} +::: dgf.jax.layers.EmbedFeatureSet + +## dgf.jax.layers.EmbedFeatureSetConfig # {: #section-embedfeaturesetconfig} +::: dgf.jax.layers.EmbedFeatureSetConfig + +## dgf.jax.layers.EmbedGraph # {: #section-embedgraph} +::: dgf.jax.layers.EmbedGraph + +## dgf.jax.layers.EmbedGraphConfig # {: #section-embedgraphconfig} +::: dgf.jax.layers.EmbedGraphConfig + +## dgf.jax.layers.GCN # {: #section-gcn} +::: dgf.jax.layers.GCN + +## dgf.jax.layers.GCNConfig # {: #section-gcnconfig} +::: dgf.jax.layers.GCNConfig + +## dgf.jax.layers.GIN # {: #section-gin} +::: dgf.jax.layers.GIN + +## dgf.jax.layers.GINConfig # {: #section-ginconfig} +::: dgf.jax.layers.GINConfig + +## dgf.jax.layers.GenericBlock # {: #section-genericblock} +::: dgf.jax.layers.GenericBlock + +## dgf.jax.layers.GenericBlockConfig # {: #section-genericblockconfig} +::: dgf.jax.layers.GenericBlockConfig + +## dgf.jax.layers.HeterogeneousGraphAttentionNetwork # {: #section-heterogeneousgraphattentionnetwork} +::: dgf.jax.layers.HeterogeneousGraphAttentionNetwork + +## dgf.jax.layers.HeterogeneousGraphAttentionNetworkConfig # {: #section-heterogeneousgraphattentionnetworkconfig} +::: dgf.jax.layers.HeterogeneousGraphAttentionNetworkConfig + +## dgf.jax.layers.HeterogeneousGraphConvolution # {: #section-heterogeneousgraphconvolution} +::: dgf.jax.layers.HeterogeneousGraphConvolution + +## dgf.jax.layers.HeterogeneousGraphConvolutionConfig # {: #section-heterogeneousgraphconvolutionconfig} +::: dgf.jax.layers.HeterogeneousGraphConvolutionConfig + +## dgf.jax.layers.MLP # {: #section-mlp} +::: dgf.jax.layers.MLP + +## dgf.jax.layers.MPNN # {: #section-mpnn} +::: dgf.jax.layers.MPNN + +## dgf.jax.layers.MPNNConfig # {: #section-mpnnconfig} +::: dgf.jax.layers.MPNNConfig + +## dgf.jax.layers.Projector # {: #section-projector} +::: dgf.jax.layers.Projector + +## dgf.jax.layers.ProjectorConfig # {: #section-projectorconfig} +::: dgf.jax.layers.ProjectorConfig + +## dgf.jax.layers.ResidualMLPV2 # {: #section-residualmlpv2} +::: dgf.jax.layers.ResidualMLPV2 + +## dgf.jax.layers.ResidualMLPV2Config # {: #section-residualmlpv2config} +::: dgf.jax.layers.ResidualMLPV2Config + +## dgf.jax.layers.identity # {: #section-identity} +::: dgf.jax.layers.identity + +## dgf.jax.layers.ingest_feature # {: #section-ingest-feature} +::: dgf.jax.layers.ingest_feature + +## dgf.jax.layers.modern_residual_mlp # {: #section-modern-residual-mlp} +::: dgf.jax.layers.modern_residual_mlp + +## dgf.jax.layers.sequential_mlp # {: #section-sequential-mlp} +::: dgf.jax.layers.sequential_mlp + diff --git a/doc/docs/api/dgf-jax.md b/doc/docs/api/dgf-jax.md new file mode 100644 index 0000000..ef0614f --- /dev/null +++ b/doc/docs/api/dgf-jax.md @@ -0,0 +1,22 @@ +--- +hide: + - toc +--- + +# dgf.jax + +## dgf.jax.JaxBaseConfig # {: #section-jaxbaseconfig} +::: dgf.jax.JaxBaseConfig + +## dgf.jax.get_activation # {: #section-get-activation} +::: dgf.jax.get_activation + +## dgf.jax.jnp_dtype_from_string # {: #section-jnp-dtype-from-string} +::: dgf.jax.jnp_dtype_from_string + +## dgf.jax.jnp_name_from_dtype # {: #section-jnp-name-from-dtype} +::: dgf.jax.jnp_name_from_dtype + +## dgf.jax.train # {: #section-train} +::: dgf.jax.train + diff --git a/doc/docs/api/dgf-learning.md b/doc/docs/api/dgf-learning.md new file mode 100644 index 0000000..d20b009 --- /dev/null +++ b/doc/docs/api/dgf-learning.md @@ -0,0 +1,25 @@ +--- +hide: + - toc +--- + +# dgf.learning + +## dgf.learning.LinkPredictionModel # {: #section-linkpredictionmodel} +::: dgf.learning.LinkPredictionModel + +## dgf.learning.Model # {: #section-model} +::: dgf.learning.Model + +## dgf.learning.NodePredictionModel # {: #section-nodepredictionmodel} +::: dgf.learning.NodePredictionModel + +## dgf.learning.load_model # {: #section-load-model} +::: dgf.learning.load_model + +## dgf.learning.train_link_model # {: #section-train-link-model} +::: dgf.learning.train_link_model + +## dgf.learning.train_node_model # {: #section-train-node-model} +::: dgf.learning.train_node_model + diff --git a/doc/docs/api/dgf-plot.md b/doc/docs/api/dgf-plot.md new file mode 100644 index 0000000..09bae65 --- /dev/null +++ b/doc/docs/api/dgf-plot.md @@ -0,0 +1,16 @@ +--- +hide: + - toc +--- + +# dgf.plot + +## dgf.plot.plot_graph # {: #section-plot-graph} +::: dgf.plot.plot_graph + +## dgf.plot.plot_nx_graph # {: #section-plot-nx-graph} +::: dgf.plot.plot_nx_graph + +## dgf.plot.plot_schema # {: #section-plot-schema} +::: dgf.plot.plot_schema + diff --git a/doc/docs/api/dgf-print.md b/doc/docs/api/dgf-print.md new file mode 100644 index 0000000..d42bcc1 --- /dev/null +++ b/doc/docs/api/dgf-print.md @@ -0,0 +1,16 @@ +--- +hide: + - toc +--- + +# dgf.print + +## dgf.print.padding # {: #section-padding} +::: dgf.print.padding + +## dgf.print.sampling_plan # {: #section-sampling-plan} +::: dgf.print.sampling_plan + +## dgf.print.schema # {: #section-schema} +::: dgf.print.schema + diff --git a/doc/docs/api/dgf-sampling.md b/doc/docs/api/dgf-sampling.md new file mode 100644 index 0000000..a5c9ce0 --- /dev/null +++ b/doc/docs/api/dgf-sampling.md @@ -0,0 +1,37 @@ +--- +hide: + - toc +--- + +# dgf.sampling + +## dgf.sampling.Sampler # {: #section-sampler} +::: dgf.sampling.Sampler + +## dgf.sampling.SamplingPlan # {: #section-samplingplan} +::: dgf.sampling.SamplingPlan + +## dgf.sampling.SimpleSamplingConfig # {: #section-simplesamplingconfig} +::: dgf.sampling.SimpleSamplingConfig + +## dgf.sampling.SpannerGraphSampler # {: #section-spannergraphsampler} +::: dgf.sampling.SpannerGraphSampler + +## dgf.sampling.create_graph_spanner_sampler # {: #section-create-graph-spanner-sampler} +::: dgf.sampling.create_graph_spanner_sampler + +## dgf.sampling.create_sampler # {: #section-create-sampler} +::: dgf.sampling.create_sampler + +## dgf.sampling.extract_beam_nodes_ids # {: #section-extract-beam-nodes-ids} +::: dgf.sampling.extract_beam_nodes_ids + +## dgf.sampling.sample_with_beam_semi_distributed_sampler # {: #section-sample-with-beam-semi-distributed-sampler} +::: dgf.sampling.sample_with_beam_semi_distributed_sampler + +## dgf.sampling.sample_with_beam_semi_distributed_sampler_v2 # {: #section-sample-with-beam-semi-distributed-sampler-v2} +::: dgf.sampling.sample_with_beam_semi_distributed_sampler_v2 + +## dgf.sampling.simple_sampling_config_to_sampling_plan # {: #section-simple-sampling-config-to-sampling-plan} +::: dgf.sampling.simple_sampling_config_to_sampling_plan + diff --git a/doc/docs/api/dgf-train.md b/doc/docs/api/dgf-train.md new file mode 100644 index 0000000..7ed5f54 --- /dev/null +++ b/doc/docs/api/dgf-train.md @@ -0,0 +1,10 @@ +--- +hide: + - toc +--- + +# dgf.train + +## dgf.train.EmbedNodesetFeaturesModule # {: #section-embednodesetfeaturesmodule} +::: dgf.train.EmbedNodesetFeaturesModule + diff --git a/doc/docs/api/dgf-transform.md b/doc/docs/api/dgf-transform.md new file mode 100644 index 0000000..d74fd73 --- /dev/null +++ b/doc/docs/api/dgf-transform.md @@ -0,0 +1,76 @@ +--- +hide: + - toc +--- + +# dgf.transform + +## dgf.transform.AutoNormalizeConfig # {: #section-autonormalizeconfig} +::: dgf.transform.AutoNormalizeConfig + +## dgf.transform.ContainsLabelPredicate # {: #section-containslabelpredicate} +::: dgf.transform.ContainsLabelPredicate + +## dgf.transform.DictionaryIndexNormalizer # {: #section-dictionaryindexnormalizer} +::: dgf.transform.DictionaryIndexNormalizer + +## dgf.transform.GNNDatasetPreparator # {: #section-gnndatasetpreparator} +::: dgf.transform.GNNDatasetPreparator + +## dgf.transform.GraphNormalizer # {: #section-graphnormalizer} +::: dgf.transform.GraphNormalizer + +## dgf.transform.GraphNormalizerConfig # {: #section-graphnormalizerconfig} +::: dgf.transform.GraphNormalizerConfig + +## dgf.transform.IdentityNormalizer # {: #section-identitynormalizer} +::: dgf.transform.IdentityNormalizer + +## dgf.transform.NumNodesPredicate # {: #section-numnodespredicate} +::: dgf.transform.NumNodesPredicate + +## dgf.transform.SoftQuantileNormalizer # {: #section-softquantilenormalizer} +::: dgf.transform.SoftQuantileNormalizer + +## dgf.transform.apply_feature # {: #section-apply-feature} +::: dgf.transform.apply_feature + +## dgf.transform.auto_normalize # {: #section-auto-normalize} +::: dgf.transform.auto_normalize + +## dgf.transform.batch_indices_generator # {: #section-batch-indices-generator} +::: dgf.transform.batch_indices_generator + +## dgf.transform.drop_edge_features # {: #section-drop-edge-features} +::: dgf.transform.drop_edge_features + +## dgf.transform.drop_edge_features_from_schema # {: #section-drop-edge-features-from-schema} +::: dgf.transform.drop_edge_features_from_schema + +## dgf.transform.filter_graph # {: #section-filter-graph} +::: dgf.transform.filter_graph + +## dgf.transform.filter_graphs # {: #section-filter-graphs} +::: dgf.transform.filter_graphs + +## dgf.transform.filter_schema # {: #section-filter-schema} +::: dgf.transform.filter_schema + +## dgf.transform.homogeneous_graph_piece_to_nx # {: #section-homogeneous-graph-piece-to-nx} +::: dgf.transform.homogeneous_graph_piece_to_nx + +## dgf.transform.homogenize # {: #section-homogenize} +::: dgf.transform.homogenize + +## dgf.transform.merge_graphs # {: #section-merge-graphs} +::: dgf.transform.merge_graphs + +## dgf.transform.propagate_timestamp_to_edges # {: #section-propagate-timestamp-to-edges} +::: dgf.transform.propagate_timestamp_to_edges + +## dgf.transform.remove_padding_sentinels # {: #section-remove-padding-sentinels} +::: dgf.transform.remove_padding_sentinels + +## dgf.transform.table2graph # {: #section-table2graph} +::: dgf.transform.table2graph + diff --git a/doc/docs/api/dgf-validate.md b/doc/docs/api/dgf-validate.md new file mode 100644 index 0000000..dd8e3a2 --- /dev/null +++ b/doc/docs/api/dgf-validate.md @@ -0,0 +1,10 @@ +--- +hide: + - toc +--- + +# dgf.validate + +## dgf.validate.validate_graph # {: #section-validate-graph} +::: dgf.validate.validate_graph + diff --git a/doc/docs/api_details.md b/doc/docs/api_details.md deleted file mode 100644 index 37927c9..0000000 --- a/doc/docs/api_details.md +++ /dev/null @@ -1,580 +0,0 @@ ---- -hide: - - toc ---- - -# Detailed API - -## dgf.analyse.feature_statistics # {: #section-dgf-analyse-feature-statistics} -::: dgf.analyse.feature_statistics - -## dgf.analyse.feature_statistics_from_graphs # {: #section-dgf-analyse-feature-statistics-from-graphs} -::: dgf.analyse.feature_statistics_from_graphs - -## dgf.analyse.padding_from_graph_generator # {: #section-dgf-analyse-padding-from-graph-generator} -::: dgf.analyse.padding_from_graph_generator - -## dgf.analyse.print_schema # {: #section-dgf-analyse-print-schema} -::: dgf.analyse.print_schema - -## dgf.convert.graph_dict_to_graph # {: #section-dgf-convert-graph-dict-to-graph} -::: dgf.convert.graph_dict_to_graph - -## dgf.convert.graph_to_jax_graph # {: #section-dgf-convert-graph-to-jax-graph} -::: dgf.convert.graph_to_jax_graph - -## dgf.convert.graph_to_networkx # {: #section-dgf-convert-graph-to-networkx} -::: dgf.convert.graph_to_networkx - -## dgf.convert.graph_to_serialized_tfgnn_graph # {: #section-dgf-convert-graph-to-serialized-tfgnn-graph} -::: dgf.convert.graph_to_serialized_tfgnn_graph - -## dgf.convert.graph_to_sparse_deferred_struct # {: #section-dgf-convert-graph-to-sparse-deferred-struct} -::: dgf.convert.graph_to_sparse_deferred_struct - -## dgf.convert.graph_to_tf_graph # {: #section-dgf-convert-graph-to-tf-graph} -::: dgf.convert.graph_to_tf_graph - -## dgf.convert.graph_to_tfgnn_graph # {: #section-dgf-convert-graph-to-tfgnn-graph} -::: dgf.convert.graph_to_tfgnn_graph - -## dgf.convert.graph_to_tfgnn_graph_dict # {: #section-dgf-convert-graph-to-tfgnn-graph-dict} -::: dgf.convert.graph_to_tfgnn_graph_dict - -## dgf.convert.graphs_to_serialized_tfgnn_graphs # {: #section-dgf-convert-graphs-to-serialized-tfgnn-graphs} -::: dgf.convert.graphs_to_serialized_tfgnn_graphs - -## dgf.convert.networkx_to_graph # {: #section-dgf-convert-networkx-to-graph} -::: dgf.convert.networkx_to_graph - -## dgf.convert.schema_to_spanner_ddl # {: #section-dgf-convert-schema-to-spanner-ddl} -::: dgf.convert.schema_to_spanner_ddl - -## dgf.convert.schema_to_sparse_deferred_schema # {: #section-dgf-convert-schema-to-sparse-deferred-schema} -::: dgf.convert.schema_to_sparse_deferred_schema - -## dgf.convert.schema_to_tfgnn_schema # {: #section-dgf-convert-schema-to-tfgnn-schema} -::: dgf.convert.schema_to_tfgnn_schema - -## dgf.convert.sparse_deferred_struct_to_graph # {: #section-dgf-convert-sparse-deferred-struct-to-graph} -::: dgf.convert.sparse_deferred_struct_to_graph - -## dgf.convert.tf_graph_dict_to_tf_graph # {: #section-dgf-convert-tf-graph-dict-to-tf-graph} -::: dgf.convert.tf_graph_dict_to_tf_graph - -## dgf.convert.tf_graph_to_tf_graph_dict # {: #section-dgf-convert-tf-graph-to-tf-graph-dict} -::: dgf.convert.tf_graph_to_tf_graph_dict - -## dgf.convert.tfgnn_graph_to_graph # {: #section-dgf-convert-tfgnn-graph-to-graph} -::: dgf.convert.tfgnn_graph_to_graph - -## dgf.convert.tfgnn_schema_to_schema # {: #section-dgf-convert-tfgnn-schema-to-schema} -::: dgf.convert.tfgnn_schema_to_schema - -## dgf.data.EdgeSchema # {: #section-dgf-data-edgeschema} -::: dgf.data.EdgeSchema - -## dgf.data.EdgeSetPadding # {: #section-dgf-data-edgesetpadding} -::: dgf.data.EdgeSetPadding - -## dgf.data.FeatureFormat # {: #section-dgf-data-featureformat} -::: dgf.data.FeatureFormat - -## dgf.data.FeatureSchema # {: #section-dgf-data-featureschema} -::: dgf.data.FeatureSchema - -## dgf.data.FeatureSemantic # {: #section-dgf-data-featuresemantic} -::: dgf.data.FeatureSemantic - -## dgf.data.FeatureSetStatistics # {: #section-dgf-data-featuresetstatistics} -::: dgf.data.FeatureSetStatistics - -## dgf.data.FeatureStatistics # {: #section-dgf-data-featurestatistics} -::: dgf.data.FeatureStatistics - -## dgf.data.GraphFeatureStatistics # {: #section-dgf-data-graphfeaturestatistics} -::: dgf.data.GraphFeatureStatistics - -## dgf.data.GraphSchema # {: #section-dgf-data-graphschema} -::: dgf.data.GraphSchema - -## dgf.data.GraphSchemaFilter # {: #section-dgf-data-graphschemafilter} -::: dgf.data.GraphSchemaFilter - -## dgf.data.GraphSchemaV2 # {: #section-dgf-data-graphschemav2} -::: dgf.data.GraphSchemaV2 - -## dgf.data.InMemoryEdgeSet # {: #section-dgf-data-inmemoryedgeset} -::: dgf.data.InMemoryEdgeSet - -## dgf.data.InMemoryGraph # {: #section-dgf-data-inmemorygraph} -::: dgf.data.InMemoryGraph - -## dgf.data.InMemoryNodeSet # {: #section-dgf-data-inmemorynodeset} -::: dgf.data.InMemoryNodeSet - -## dgf.data.JaxInMemoryEdgeSet # {: #section-dgf-data-jaxinmemoryedgeset} -::: dgf.data.JaxInMemoryEdgeSet - -## dgf.data.JaxInMemoryGraph # {: #section-dgf-data-jaxinmemorygraph} -::: dgf.data.JaxInMemoryGraph - -## dgf.data.JaxInMemoryNodeSet # {: #section-dgf-data-jaxinmemorynodeset} -::: dgf.data.JaxInMemoryNodeSet - -## dgf.data.NodeSchema # {: #section-dgf-data-nodeschema} -::: dgf.data.NodeSchema - -## dgf.data.NodeSetPadding # {: #section-dgf-data-nodesetpadding} -::: dgf.data.NodeSetPadding - -## dgf.data.Padding # {: #section-dgf-data-padding} -::: dgf.data.Padding - -## dgf.data.TFInMemoryEdgeSet # {: #section-dgf-data-tfinmemoryedgeset} -::: dgf.data.TFInMemoryEdgeSet - -## dgf.data.TFInMemoryGraph # {: #section-dgf-data-tfinmemorygraph} -::: dgf.data.TFInMemoryGraph - -## dgf.data.TFInMemoryNodeSet # {: #section-dgf-data-tfinmemorynodeset} -::: dgf.data.TFInMemoryNodeSet - -## dgf.exception.InsufficientPaddingError # {: #section-dgf-exception-insufficientpaddingerror} -::: dgf.exception.InsufficientPaddingError - -## dgf.filesystem.create_gcs_bucket # {: #section-dgf-filesystem-create-gcs-bucket} -::: dgf.filesystem.create_gcs_bucket - -## dgf.filesystem.exists # {: #section-dgf-filesystem-exists} -::: dgf.filesystem.exists - -## dgf.filesystem.glob # {: #section-dgf-filesystem-glob} -::: dgf.filesystem.glob - -## dgf.filesystem.is_gcs_path # {: #section-dgf-filesystem-is-gcs-path} -::: dgf.filesystem.is_gcs_path - -## dgf.filesystem.makedirs # {: #section-dgf-filesystem-makedirs} -::: dgf.filesystem.makedirs - -## dgf.filesystem.open_read # {: #section-dgf-filesystem-open-read} -::: dgf.filesystem.open_read - -## dgf.filesystem.remove_paths # {: #section-dgf-filesystem-remove-paths} -::: dgf.filesystem.remove_paths - -## dgf.filesystem.rename # {: #section-dgf-filesystem-rename} -::: dgf.filesystem.rename - -## dgf.filesystem.rmtree # {: #section-dgf-filesystem-rmtree} -::: dgf.filesystem.rmtree - -## dgf.generate.EdgeNeighborGenerator # {: #section-dgf-generate-edgeneighborgenerator} -::: dgf.generate.EdgeNeighborGenerator - -## dgf.generate.RandomNegativeSampler # {: #section-dgf-generate-randomnegativesampler} -::: dgf.generate.RandomNegativeSampler - -## dgf.generate.RandomWalkNegativeSampler # {: #section-dgf-generate-randomwalknegativesampler} -::: dgf.generate.RandomWalkNegativeSampler - -## dgf.generate.SyntheticGraphSampleConfig # {: #section-dgf-generate-syntheticgraphsampleconfig} -::: dgf.generate.SyntheticGraphSampleConfig - -## dgf.generate.generate_synthetic_graph_sample # {: #section-dgf-generate-generate-synthetic-graph-sample} -::: dgf.generate.generate_synthetic_graph_sample - -## dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs # {: #section-dgf-generate-write-synthetic-graph-sample-as-tfgnn-graphs} -::: dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs - -## dgf.io.cache # {: #section-dgf-io-cache} -::: dgf.io.cache - -## dgf.io.create_spanner_tables_from_graph_schema # {: #section-dgf-io-create-spanner-tables-from-graph-schema} -::: dgf.io.create_spanner_tables_from_graph_schema - -## dgf.io.export_bigquery_to_disk # {: #section-dgf-io-export-bigquery-to-disk} -::: dgf.io.export_bigquery_to_disk - -## dgf.io.fetch_graphland_graph # {: #section-dgf-io-fetch-graphland-graph} -::: dgf.io.fetch_graphland_graph - -## dgf.io.fetch_ogb_graph # {: #section-dgf-io-fetch-ogb-graph} -::: dgf.io.fetch_ogb_graph - -## dgf.io.read_bigquery_graph # {: #section-dgf-io-read-bigquery-graph} -::: dgf.io.read_bigquery_graph - -## dgf.io.read_bigquery_graph_schema # {: #section-dgf-io-read-bigquery-graph-schema} -::: dgf.io.read_bigquery_graph_schema - -## dgf.io.read_feature_statistics # {: #section-dgf-io-read-feature-statistics} -::: dgf.io.read_feature_statistics - -## dgf.io.read_graph # {: #section-dgf-io-read-graph} -::: dgf.io.read_graph - -## dgf.io.read_graphai_hgraph # {: #section-dgf-io-read-graphai-hgraph} -::: dgf.io.read_graphai_hgraph - -## dgf.io.read_schema # {: #section-dgf-io-read-schema} -::: dgf.io.read_schema - -## dgf.io.read_spanner_graph # {: #section-dgf-io-read-spanner-graph} -::: dgf.io.read_spanner_graph - -## dgf.io.read_spanner_graph_schema # {: #section-dgf-io-read-spanner-graph-schema} -::: dgf.io.read_spanner_graph_schema - -## dgf.io.read_text_proto # {: #section-dgf-io-read-text-proto} -::: dgf.io.read_text_proto - -## dgf.io.read_tfgnn_graphs # {: #section-dgf-io-read-tfgnn-graphs} -::: dgf.io.read_tfgnn_graphs - -## dgf.io.write_feature_statistics # {: #section-dgf-io-write-feature-statistics} -::: dgf.io.write_feature_statistics - -## dgf.io.write_graph # {: #section-dgf-io-write-graph} -::: dgf.io.write_graph - -## dgf.io.write_schema # {: #section-dgf-io-write-schema} -::: dgf.io.write_schema - -## dgf.io.write_text_proto # {: #section-dgf-io-write-text-proto} -::: dgf.io.write_text_proto - -## dgf.io.write_tfgnn_graphs # {: #section-dgf-io-write-tfgnn-graphs} -::: dgf.io.write_tfgnn_graphs - -## dgf.jax.JaxBaseConfig # {: #section-dgf-jax-jaxbaseconfig} -::: dgf.jax.JaxBaseConfig - -## dgf.jax.get_activation # {: #section-dgf-jax-get-activation} -::: dgf.jax.get_activation - -## dgf.jax.jnp_dtype_from_string # {: #section-dgf-jax-jnp-dtype-from-string} -::: dgf.jax.jnp_dtype_from_string - -## dgf.jax.jnp_name_from_dtype # {: #section-dgf-jax-jnp-name-from-dtype} -::: dgf.jax.jnp_name_from_dtype - -## dgf.jax.train # {: #section-dgf-jax-train} -::: dgf.jax.train - -## dgf.jax.layers.ClassificationHead # {: #section-dgf-jax-layers-classificationhead} -::: dgf.jax.layers.ClassificationHead - -## dgf.jax.layers.ClassificationHeadConfig # {: #section-dgf-jax-layers-classificationheadconfig} -::: dgf.jax.layers.ClassificationHeadConfig - -## dgf.jax.layers.ConditionalGIN # {: #section-dgf-jax-layers-conditionalgin} -::: dgf.jax.layers.ConditionalGIN - -## dgf.jax.layers.EmbedAndHomogenizeGraph # {: #section-dgf-jax-layers-embedandhomogenizegraph} -::: dgf.jax.layers.EmbedAndHomogenizeGraph - -## dgf.jax.layers.EmbedAndHomogenizeGraphConfig # {: #section-dgf-jax-layers-embedandhomogenizegraphconfig} -::: dgf.jax.layers.EmbedAndHomogenizeGraphConfig - -## dgf.jax.layers.EmbedFeatureSet # {: #section-dgf-jax-layers-embedfeatureset} -::: dgf.jax.layers.EmbedFeatureSet - -## dgf.jax.layers.EmbedFeatureSetConfig # {: #section-dgf-jax-layers-embedfeaturesetconfig} -::: dgf.jax.layers.EmbedFeatureSetConfig - -## dgf.jax.layers.EmbedGraph # {: #section-dgf-jax-layers-embedgraph} -::: dgf.jax.layers.EmbedGraph - -## dgf.jax.layers.EmbedGraphConfig # {: #section-dgf-jax-layers-embedgraphconfig} -::: dgf.jax.layers.EmbedGraphConfig - -## dgf.jax.layers.GCN # {: #section-dgf-jax-layers-gcn} -::: dgf.jax.layers.GCN - -## dgf.jax.layers.GCNConfig # {: #section-dgf-jax-layers-gcnconfig} -::: dgf.jax.layers.GCNConfig - -## dgf.jax.layers.GIN # {: #section-dgf-jax-layers-gin} -::: dgf.jax.layers.GIN - -## dgf.jax.layers.GINConfig # {: #section-dgf-jax-layers-ginconfig} -::: dgf.jax.layers.GINConfig - -## dgf.jax.layers.GenericBlock # {: #section-dgf-jax-layers-genericblock} -::: dgf.jax.layers.GenericBlock - -## dgf.jax.layers.GenericBlockConfig # {: #section-dgf-jax-layers-genericblockconfig} -::: dgf.jax.layers.GenericBlockConfig - -## dgf.jax.layers.HeterogeneousGraphAttentionNetwork # {: #section-dgf-jax-layers-heterogeneousgraphattentionnetwork} -::: dgf.jax.layers.HeterogeneousGraphAttentionNetwork - -## dgf.jax.layers.HeterogeneousGraphAttentionNetworkConfig # {: #section-dgf-jax-layers-heterogeneousgraphattentionnetworkconfig} -::: dgf.jax.layers.HeterogeneousGraphAttentionNetworkConfig - -## dgf.jax.layers.HeterogeneousGraphConvolution # {: #section-dgf-jax-layers-heterogeneousgraphconvolution} -::: dgf.jax.layers.HeterogeneousGraphConvolution - -## dgf.jax.layers.HeterogeneousGraphConvolutionConfig # {: #section-dgf-jax-layers-heterogeneousgraphconvolutionconfig} -::: dgf.jax.layers.HeterogeneousGraphConvolutionConfig - -## dgf.jax.layers.MLP # {: #section-dgf-jax-layers-mlp} -::: dgf.jax.layers.MLP - -## dgf.jax.layers.MPNN # {: #section-dgf-jax-layers-mpnn} -::: dgf.jax.layers.MPNN - -## dgf.jax.layers.MPNNConfig # {: #section-dgf-jax-layers-mpnnconfig} -::: dgf.jax.layers.MPNNConfig - -## dgf.jax.layers.Projector # {: #section-dgf-jax-layers-projector} -::: dgf.jax.layers.Projector - -## dgf.jax.layers.ProjectorConfig # {: #section-dgf-jax-layers-projectorconfig} -::: dgf.jax.layers.ProjectorConfig - -## dgf.jax.layers.ResidualMLPV2 # {: #section-dgf-jax-layers-residualmlpv2} -::: dgf.jax.layers.ResidualMLPV2 - -## dgf.jax.layers.ResidualMLPV2Config # {: #section-dgf-jax-layers-residualmlpv2config} -::: dgf.jax.layers.ResidualMLPV2Config - -## dgf.jax.layers.identity # {: #section-dgf-jax-layers-identity} -::: dgf.jax.layers.identity - -## dgf.jax.layers.ingest_feature # {: #section-dgf-jax-layers-ingest-feature} -::: dgf.jax.layers.ingest_feature - -## dgf.jax.layers.modern_residual_mlp # {: #section-dgf-jax-layers-modern-residual-mlp} -::: dgf.jax.layers.modern_residual_mlp - -## dgf.jax.layers.sequential_mlp # {: #section-dgf-jax-layers-sequential-mlp} -::: dgf.jax.layers.sequential_mlp - -## dgf.learning.LinkPredictionModel # {: #section-dgf-learning-linkpredictionmodel} -::: dgf.learning.LinkPredictionModel - -## dgf.learning.Model # {: #section-dgf-learning-model} -::: dgf.learning.Model - -## dgf.learning.NodePredictionModel # {: #section-dgf-learning-nodepredictionmodel} -::: dgf.learning.NodePredictionModel - -## dgf.learning.load_model # {: #section-dgf-learning-load-model} -::: dgf.learning.load_model - -## dgf.learning.train_link_model # {: #section-dgf-learning-train-link-model} -::: dgf.learning.train_link_model - -## dgf.learning.train_node_model # {: #section-dgf-learning-train-node-model} -::: dgf.learning.train_node_model - -## dgf.plot.plot_graph # {: #section-dgf-plot-plot-graph} -::: dgf.plot.plot_graph - -## dgf.plot.plot_nx_graph # {: #section-dgf-plot-plot-nx-graph} -::: dgf.plot.plot_nx_graph - -## dgf.plot.plot_schema # {: #section-dgf-plot-plot-schema} -::: dgf.plot.plot_schema - -## dgf.print.padding # {: #section-dgf-print-padding} -::: dgf.print.padding - -## dgf.print.sampling_plan # {: #section-dgf-print-sampling-plan} -::: dgf.print.sampling_plan - -## dgf.print.schema # {: #section-dgf-print-schema} -::: dgf.print.schema - -## dgf.sampling.Sampler # {: #section-dgf-sampling-sampler} -::: dgf.sampling.Sampler - -## dgf.sampling.SamplingPlan # {: #section-dgf-sampling-samplingplan} -::: dgf.sampling.SamplingPlan - -## dgf.sampling.SimpleSamplingConfig # {: #section-dgf-sampling-simplesamplingconfig} -::: dgf.sampling.SimpleSamplingConfig - -## dgf.sampling.SpannerGraphSampler # {: #section-dgf-sampling-spannergraphsampler} -::: dgf.sampling.SpannerGraphSampler - -## dgf.sampling.create_graph_spanner_sampler # {: #section-dgf-sampling-create-graph-spanner-sampler} -::: dgf.sampling.create_graph_spanner_sampler - -## dgf.sampling.create_sampler # {: #section-dgf-sampling-create-sampler} -::: dgf.sampling.create_sampler - -## dgf.sampling.extract_beam_nodes_ids # {: #section-dgf-sampling-extract-beam-nodes-ids} -::: dgf.sampling.extract_beam_nodes_ids - -## dgf.sampling.sample_with_beam_semi_distributed_sampler # {: #section-dgf-sampling-sample-with-beam-semi-distributed-sampler} -::: dgf.sampling.sample_with_beam_semi_distributed_sampler - -## dgf.sampling.sample_with_beam_semi_distributed_sampler_v2 # {: #section-dgf-sampling-sample-with-beam-semi-distributed-sampler-v2} -::: dgf.sampling.sample_with_beam_semi_distributed_sampler_v2 - -## dgf.sampling.simple_sampling_config_to_sampling_plan # {: #section-dgf-sampling-simple-sampling-config-to-sampling-plan} -::: dgf.sampling.simple_sampling_config_to_sampling_plan - -## dgf.train.EmbedNodesetFeaturesModule # {: #section-dgf-train-embednodesetfeaturesmodule} -::: dgf.train.EmbedNodesetFeaturesModule - -## dgf.transform.AutoNormalizeConfig # {: #section-dgf-transform-autonormalizeconfig} -::: dgf.transform.AutoNormalizeConfig - -## dgf.transform.ContainsLabelPredicate # {: #section-dgf-transform-containslabelpredicate} -::: dgf.transform.ContainsLabelPredicate - -## dgf.transform.DictionaryIndexNormalizer # {: #section-dgf-transform-dictionaryindexnormalizer} -::: dgf.transform.DictionaryIndexNormalizer - -## dgf.transform.GNNDatasetPreparator # {: #section-dgf-transform-gnndatasetpreparator} -::: dgf.transform.GNNDatasetPreparator - -## dgf.transform.GraphNormalizer # {: #section-dgf-transform-graphnormalizer} -::: dgf.transform.GraphNormalizer - -## dgf.transform.GraphNormalizerConfig # {: #section-dgf-transform-graphnormalizerconfig} -::: dgf.transform.GraphNormalizerConfig - -## dgf.transform.IdentityNormalizer # {: #section-dgf-transform-identitynormalizer} -::: dgf.transform.IdentityNormalizer - -## dgf.transform.NumNodesPredicate # {: #section-dgf-transform-numnodespredicate} -::: dgf.transform.NumNodesPredicate - -## dgf.transform.SoftQuantileNormalizer # {: #section-dgf-transform-softquantilenormalizer} -::: dgf.transform.SoftQuantileNormalizer - -## dgf.transform.apply_feature # {: #section-dgf-transform-apply-feature} -::: dgf.transform.apply_feature - -## dgf.transform.auto_normalize # {: #section-dgf-transform-auto-normalize} -::: dgf.transform.auto_normalize - -## dgf.transform.batch_indices_generator # {: #section-dgf-transform-batch-indices-generator} -::: dgf.transform.batch_indices_generator - -## dgf.transform.drop_edge_features # {: #section-dgf-transform-drop-edge-features} -::: dgf.transform.drop_edge_features - -## dgf.transform.drop_edge_features_from_schema # {: #section-dgf-transform-drop-edge-features-from-schema} -::: dgf.transform.drop_edge_features_from_schema - -## dgf.transform.filter_graph # {: #section-dgf-transform-filter-graph} -::: dgf.transform.filter_graph - -## dgf.transform.filter_graphs # {: #section-dgf-transform-filter-graphs} -::: dgf.transform.filter_graphs - -## dgf.transform.filter_schema # {: #section-dgf-transform-filter-schema} -::: dgf.transform.filter_schema - -## dgf.transform.homogeneous_graph_piece_to_nx # {: #section-dgf-transform-homogeneous-graph-piece-to-nx} -::: dgf.transform.homogeneous_graph_piece_to_nx - -## dgf.transform.homogenize # {: #section-dgf-transform-homogenize} -::: dgf.transform.homogenize - -## dgf.transform.merge_graphs # {: #section-dgf-transform-merge-graphs} -::: dgf.transform.merge_graphs - -## dgf.transform.propagate_timestamp_to_edges # {: #section-dgf-transform-propagate-timestamp-to-edges} -::: dgf.transform.propagate_timestamp_to_edges - -## dgf.transform.remove_padding_sentinels # {: #section-dgf-transform-remove-padding-sentinels} -::: dgf.transform.remove_padding_sentinels - -## dgf.transform.table2graph # {: #section-dgf-transform-table2graph} -::: dgf.transform.table2graph - -## dgf.validate.validate_graph # {: #section-dgf-validate-validate-graph} -::: dgf.validate.validate_graph - -## dgf.beam.program_started # {: #section-dgf-beam-program-started} -::: dgf.beam.program_started - -## dgf.beam.runner_from_name # {: #section-dgf-beam-runner-from-name} -::: dgf.beam.runner_from_name - -## dgf.beam.runner_from_options # {: #section-dgf-beam-runner-from-options} -::: dgf.beam.runner_from_options - -## dgf.beam.analyse.feature_statistics # {: #section-dgf-beam-analyse-feature-statistics} -::: dgf.beam.analyse.feature_statistics - -## dgf.beam.analyse.feature_statistics_from_graphs # {: #section-dgf-beam-analyse-feature-statistics-from-graphs} -::: dgf.beam.analyse.feature_statistics_from_graphs - -## dgf.beam.data.Edge # {: #section-dgf-beam-data-edge} -::: dgf.beam.data.Edge - -## dgf.beam.data.Graph # {: #section-dgf-beam-data-graph} -::: dgf.beam.data.Graph - -## dgf.beam.data.HeterogeniousGraph # {: #section-dgf-beam-data-heterogeniousgraph} -::: dgf.beam.data.HeterogeniousGraph - -## dgf.beam.data.HomogeneousGraph # {: #section-dgf-beam-data-homogeneousgraph} -::: dgf.beam.data.HomogeneousGraph - -## dgf.beam.data.KeyedInMemoryGraph # {: #section-dgf-beam-data-keyedinmemorygraph} -::: dgf.beam.data.KeyedInMemoryGraph - -## dgf.beam.data.Node # {: #section-dgf-beam-data-node} -::: dgf.beam.data.Node - -## dgf.beam.io.CreateSpannerTables # {: #section-dgf-beam-io-createspannertables} -::: dgf.beam.io.CreateSpannerTables - -## dgf.beam.io.read_bigquery_graph # {: #section-dgf-beam-io-read-bigquery-graph} -::: dgf.beam.io.read_bigquery_graph - -## dgf.beam.io.read_graph # {: #section-dgf-beam-io-read-graph} -::: dgf.beam.io.read_graph - -## dgf.beam.io.read_graphai_hgraph # {: #section-dgf-beam-io-read-graphai-hgraph} -::: dgf.beam.io.read_graphai_hgraph - -## dgf.beam.io.read_spanner_graph # {: #section-dgf-beam-io-read-spanner-graph} -::: dgf.beam.io.read_spanner_graph - -## dgf.beam.io.read_tfgnn_graphs # {: #section-dgf-beam-io-read-tfgnn-graphs} -::: dgf.beam.io.read_tfgnn_graphs - -## dgf.beam.io.write_edge_set_to_spanner # {: #section-dgf-beam-io-write-edge-set-to-spanner} -::: dgf.beam.io.write_edge_set_to_spanner - -## dgf.beam.io.write_feature_statistics # {: #section-dgf-beam-io-write-feature-statistics} -::: dgf.beam.io.write_feature_statistics - -## dgf.beam.io.write_graph # {: #section-dgf-beam-io-write-graph} -::: dgf.beam.io.write_graph - -## dgf.beam.io.write_graphai_hgraph # {: #section-dgf-beam-io-write-graphai-hgraph} -::: dgf.beam.io.write_graphai_hgraph - -## dgf.beam.io.write_node_set_to_spanner # {: #section-dgf-beam-io-write-node-set-to-spanner} -::: dgf.beam.io.write_node_set_to_spanner - -## dgf.beam.io.write_spanner # {: #section-dgf-beam-io-write-spanner} -::: dgf.beam.io.write_spanner - -## dgf.beam.io.write_tfgnn_graphs # {: #section-dgf-beam-io-write-tfgnn-graphs} -::: dgf.beam.io.write_tfgnn_graphs - -## dgf.beam.sampling.extract_nodes_ids # {: #section-dgf-beam-sampling-extract-nodes-ids} -::: dgf.beam.sampling.extract_nodes_ids - -## dgf.beam.sampling.semi_distributed_sampler_v1 # {: #section-dgf-beam-sampling-semi-distributed-sampler-v1} -::: dgf.beam.sampling.semi_distributed_sampler_v1 - -## dgf.beam.sampling.semi_distributed_sampler_v2 # {: #section-dgf-beam-sampling-semi-distributed-sampler-v2} -::: dgf.beam.sampling.semi_distributed_sampler_v2 - -## dgf.beam.transform.reverse_edges # {: #section-dgf-beam-transform-reverse-edges} -::: dgf.beam.transform.reverse_edges - diff --git a/doc/requirements.txt b/doc/requirements.txt index 8254b91..57fa790 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,4 +3,3 @@ mkdocs-material mkdocs-jupyter mkdocs-gen-files mkdocstrings[python] -dgf