Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Constantin M Adam <[email protected]>
  • Loading branch information
cmadam committed Oct 10, 2024
1 parent 8d9bb66 commit 66f3c58
Showing 1 changed file with 3 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ def get_transform_config(
"""
Get the dictionary of configuration that will be provided to the transform's initializer.
This is the opportunity for this runtime to create a new set of configuration based on the
config/params provided to this instance's initializer. This may include the addition
of new configuration data such as ray shared memory, new actors, etc, that might be needed and
expected by the transform in its initializer and/or transform() methods.
config/params provided to this instance's initializer.
:param partition - the partition assigned to this worker, needed by transforms like doc_id
:param data_access_factory - data access factory class being used by the RayOrchestrator.
:param statistics - reference to statistics actor
Expand All @@ -57,7 +55,8 @@ def get_bcast_params(self, data_access_factory: DataAccessFactoryBase) -> dict[s
def compute_execution_stats(self, stats: TransformStatistics) -> None:
"""
Update/augment the given statistics object with runtime-specific additions/modifications.
This method does not return a value; the job execution statistics are generally reported
as metadata by the Spark Orchestrator.
:param stats: output of statistics as aggregated across all calls to all transforms.
:return: job execution statistics. These are generally reported as metadata by the Ray Orchestrator.
"""
pass

0 comments on commit 66f3c58

Please sign in to comment.