Skip to content

Commit

Permalink
Update comments.
Browse files Browse the repository at this point in the history
Signed-off-by: Revital Sur <[email protected]>
  • Loading branch information
revit13 committed Sep 25, 2024
1 parent ceaf162 commit daca127
Show file tree
Hide file tree
Showing 28 changed files with 56 additions and 0 deletions.
2 changes: 2 additions & 0 deletions kfp/doc/simple_transform_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ The parameters used here are as follows:
* memory - memory
* image - image to use
* image_pull_secret - image pull secret
* tolerations - (optional) tolerations for the ray pods
* ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
* replicas - number of replicas to create
* max_replicas - max number of replicas
Expand All @@ -119,6 +120,7 @@ The parameters used here are as follows:
* memory - memory
* image - image to use
* image_pull_secret - image pull secret
* tolerations - (optional) tolerations for the ray pods
* server_url - server url
* additional_params: additional (support) parameters, containing the following:
* wait_interval - wait interval for API server, sec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ def {{ pipeline_name }}(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -143,6 +144,7 @@ def {{ pipeline_name }}(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/code/code2parquet/kfp_ray/code2parquet_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ def code2parquet(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -146,6 +147,7 @@ def code2parquet(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/code/code_quality/kfp_ray/code_quality_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ def code_quality(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -143,6 +144,7 @@ def code_quality(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/code/header_cleanser/kfp_ray/header_cleanser_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ def header_cleanser(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -140,6 +141,7 @@ def header_cleanser(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/code/malware/kfp_ray/malware_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ def malware(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -133,6 +134,7 @@ def malware(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/code/proglang_select/kfp_ray/proglang_select_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ def lang_select(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -136,6 +137,7 @@ def lang_select(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ def repo_level_order(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -163,6 +164,7 @@ def repo_level_order(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ def doc_chunk(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -139,6 +140,7 @@ def doc_chunk(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/doc_chunk/kfp_ray/doc_chunk_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ def doc_chunk(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -140,6 +141,7 @@ def doc_chunk(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ def doc_quality(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -136,6 +137,7 @@ def doc_quality(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/doc_quality/kfp_ray/doc_quality_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ def doc_quality(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -136,6 +137,7 @@ def doc_quality(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/lang_id/kfp_ray/lang_id_multiple_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ def lang_id(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -145,6 +146,7 @@ def lang_id(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/lang_id/kfp_ray/lang_id_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ def lang_id(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -146,6 +147,7 @@ def lang_id(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ def pdf2parquet(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -133,6 +134,7 @@ def pdf2parquet(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/pdf2parquet/kfp_ray/pdf2parquet_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ def pdf2parquet(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -137,6 +138,7 @@ def pdf2parquet(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/pii_redactor/kfp_ray/pii_redactor_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ def pii_redactor(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -131,6 +132,7 @@ def pii_redactor(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ def text_encoder(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -136,6 +137,7 @@ def text_encoder(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/language/text_encoder/kfp_ray/text_encoder_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ def text_encoder(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -137,6 +138,7 @@ def text_encoder(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/universal/doc_id/kfp_ray/doc_id_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ def doc_id(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -147,6 +148,7 @@ def doc_id(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/universal/ededup/kfp_ray/ededup_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ def ededup(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -111,6 +112,7 @@ def ededup(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/universal/fdedup/kfp_ray/fdedup_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ def fdedup(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -125,6 +126,7 @@ def fdedup(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/universal/filter/kfp_ray/filter_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ def filtering(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -137,6 +138,7 @@ def filtering(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/universal/noop/kfp_ray/noop_multiple_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ def noop(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -130,6 +131,7 @@ def noop(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
2 changes: 2 additions & 0 deletions transforms/universal/noop/kfp_ray/noop_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ def noop(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param ray_worker_options: worker node options (we here are using only 1 worker pool), containing the following:
replicas - number of replicas to create
max_replicas - max number of replicas
Expand All @@ -133,6 +134,7 @@ def noop(
memory - memory
image - image to use
image_pull_secret - image pull secret
tolerations - (optional) tolerations for the ray pods
:param server_url - server url
:param additional_params: additional (support) parameters, containing the following:
wait_interval - wait interval for API server, sec
Expand Down
Loading

0 comments on commit daca127

Please sign in to comment.