gigl.experimental.knowledge_graph_embedding.lib.constants.gcs#

Functions#

get_applied_task_staging_path(applied_task_identifier)

Returns the GCS URI for the staging/temp path of the applied task.

get_edge_dataset_output_path(applied_task_identifier)

Returns the GCS URI for edge data to be written to (to read during training).

get_embedding_output_path(applied_task_identifier)

Returns the GCS URI for the embeddings to be written to.

get_embedding_output_path_for_dst_node(...)

Returns the GCS URI for the embedding output path for a specific source node type.

get_embedding_output_path_for_edge_type(...)

Returns the GCS URI for the embedding output path for a specific edge type.

get_embedding_output_path_for_src_node(...)

Returns the GCS URI for the embedding output path for a specific source node type.

get_enumerated_config_output_path(applied_task_identifier)

Returns the GCS URI for the path to the config to be run post enumeration of data.

Module Contents#

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_applied_task_staging_path(applied_task_identifier)[source]#

Returns the GCS URI for the staging/temp path of the applied task.

Parameters:

applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

Returns:

The GCS URI for the staging path of the applied task.

Return type:

GcsUri

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_edge_dataset_output_path(applied_task_identifier)[source]#

Returns the GCS URI for edge data to be written to (to read during training).

Parameters:

applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

Returns:

The GCS URI for the staging path of the applied task.

Return type:

GcsUri

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_embedding_output_path(applied_task_identifier)[source]#

Returns the GCS URI for the embeddings to be written to.

Parameters:

applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

Returns:

The GCS URI for the staging path of the applied task.

Return type:

GcsUri

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_embedding_output_path_for_dst_node(applied_task_identifier, edge_type)[source]#

Returns the GCS URI for the embedding output path for a specific source node type.

Parameters:
  • applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

  • edge_type (gigl.src.common.types.graph_data.EdgeType) – The edge type for which to get the embedding output path.

Returns:

The GCS URI for the embedding output path for the specified source node type.

Return type:

GcsUri

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_embedding_output_path_for_edge_type(applied_task_identifier, edge_type)[source]#

Returns the GCS URI for the embedding output path for a specific edge type.

Parameters:
  • applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

  • edge_type (gigl.src.common.types.graph_data.EdgeType) – The edge type for which to get the embedding output path.

Returns:

The GCS URI for the embedding output path for the specified edge type.

Return type:

GcsUri

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_embedding_output_path_for_src_node(applied_task_identifier, edge_type)[source]#

Returns the GCS URI for the embedding output path for a specific source node type.

Parameters:
  • applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

  • edge_type (gigl.src.common.types.graph_data.EdgeType) – The edge type for which to get the embedding output path.

Returns:

The GCS URI for the embedding output path for the specified source node type.

Return type:

GcsUri

gigl.experimental.knowledge_graph_embedding.lib.constants.gcs.get_enumerated_config_output_path(applied_task_identifier)[source]#

Returns the GCS URI for the path to the config to be run post enumeration of data.

Parameters:

applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier) – The identifier of the applied task.

Returns:

The GCS URI for the staging path of the applied task.

Return type:

GcsUri