Skip to content

Commit

Permalink
Update reference to helper with client instead.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmourafiq committed Oct 2, 2018
1 parent a4a79c4 commit 2e32c06
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 25 deletions.
4 changes: 2 additions & 2 deletions docs/templates/customization/customize_node_scheduling.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ environment:
build:
image: tensorflow/tensorflow:1.4.1-gpu-py3
build_steps:
- pip3 install --no-cache-dir -U polyaxon-helper
- pip3 install --no-cache-dir -U polyaxon-client

run:
cmd: python3 model.py # Use default params
Expand Down Expand Up @@ -121,7 +121,7 @@ environment:
build:
image: tensorflow/tensorflow:1.4.1
build_steps:
- pip install --no-cache-dir -U polyaxon-helper
- pip install --no-cache-dir -U polyaxon-client

run:
cmd: python run.py --train-steps=400 --sync
Expand Down
4 changes: 2 additions & 2 deletions docs/templates/customization/customize_outputs_and_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Polyaxon will by default mount all these volumes when it schedules the experimen
These data volumes will be accessible to you as a dictionary `{volume_name: path_to_data}`,
exported as an env variable `POLYAXON_RUN_DATA_PATHS`.

You can use as well our `helper` library `polyaxon-helper` to get access to this env variable automatically.
You can use as well our `tracking` api in `polyaxon-client` to get access to this env variable automatically.

If on the other hand, you wish to only mount one volume or a subset of the volumes,
you then need to provide this information in the polyaxonfile, e.g.
Expand All @@ -74,7 +74,7 @@ Polyaxon will, by default mount one volume, either the first one or a random one
The outputs volume will be accessible to you as a string `path_to_outputs_for_experiment`,
exported as an env variable `POLYAXON_RUN_OUTPUTS_PATH`.

You can use as well our `helper` library `polyaxon-helper` to get access to this env variable automatically.
You can use as well our `tracking` api in `polyaxon-client` to get access to this env variable automatically.

If on the other hand, you wish to mount a particular volume,
you then need to provide this information in the polyaxonfile, e.g.
Expand Down
2 changes: 1 addition & 1 deletion docs/templates/experimentation/experiment_groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ This command validate the polyaxon file, and the option `-def` returns the group
or check the [command reference](/polyaxon_cli/commands/check)

!!! tip "Polyaxon merges the combination values from matrix for a single experiment with the values from declarations and export under the environment variable name `POLYAXON_DECLARATIONS`"
Check how you can [get the experiment declarations](/reference_polyaxon_helper) to use them with your models.
Check how you can [get the experiment declarations](/tracking/exepriments) to use them with your models.

## Running a group of experiments

Expand Down
4 changes: 2 additions & 2 deletions docs/templates/experimentation/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,10 +319,10 @@ Since we have multiple jobs, Polyaxon adds the cluster definition to the docker

It also exposes some framework specific environment variables to the pods, in this case `TF_CONFIG` since we are running a Tensorflow distributed experiment.

You can also use our helper library to extract these environment variables programmatically.
You can also use our `tracking` api in `polyaxon-client` to extract these environment variables programmatically.

!!! tip "Polyaxon export your cluster definition under environment variable name `POLYAXON_CLUSTER`"
Check how you can [get the cluster definition](/reference_polyaxon_helper) to use it with your distributed deep learning model.
Check how you can [get the cluster definition](/tracking/experiments) to use it with your distributed deep learning model.

To run this distributed experiment, run

Expand Down
2 changes: 1 addition & 1 deletion docs/templates/experimentation/save_resume_restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Same as logs, the outputs are saved on the outputs volume, on:
You don't need to figure out this path or hardcode them manually,
Polyaxon will provide an environment variable for the outputs `POLYAXON_RUN_OUTPUTS_PATH`
that you can use to export your outputs, artifacts and checkpoints.
You can also use our helper to get this path [get_outputs_path](/reference_polyaxon_helper/#getting-env-variables-defined-by-polyaxon).
You can also use our client to get this path [get_outputs_path](/tracking/experiments#tracking_experiments_running_inside_polyaxon).

## Saving and checkpointing

Expand Down
8 changes: 4 additions & 4 deletions docs/templates/polyaxon_rest/resources/build_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ curl --request GET \
"config": {
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand All @@ -43,7 +43,7 @@ curl --request GET \
"node_scheduled": "gke-cluster-1-default-pool-65d093c7-7hk4",
"num_jobs": 0,
"num_experiments": 1,
"dockerfile": "\nFROM tensorflow/tensorflow:1.4.1-py3\n\nENV LC_ALL en_US.UTF-8\nENV LANG en_US.UTF-8\nENV LANGUAGE en_US.UTF-8\n# Use bash as default shell, rather than sh\nENV SHELL /bin/bash\n\nWORKDIR /code\n\nRUN pip3 install --no-cache-dir -U polyaxon-helper\nCOPY build /code\n",
"dockerfile": "\nFROM tensorflow/tensorflow:1.4.1-py3\n\nENV LC_ALL en_US.UTF-8\nENV LANG en_US.UTF-8\nENV LANGUAGE en_US.UTF-8\n# Use bash as default shell, rather than sh\nENV SHELL /bin/bash\n\nWORKDIR /code\n\nRUN pip3 install --no-cache-dir -U polyaxon-client\nCOPY build /code\n",
"commit": "2f758b8902d4cf5d4147b09706613ec108eda369",
"bookmarked": false
}
Expand Down Expand Up @@ -87,7 +87,7 @@ curl --request PATCH \
"config": {
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand All @@ -98,7 +98,7 @@ curl --request PATCH \
"node_scheduled": "gke-cluster-1-default-pool-65d093c7-7hk4",
"num_jobs": 0,
"num_experiments": 1,
"dockerfile": "\nFROM tensorflow/tensorflow:1.4.1-py3\n\nENV LC_ALL en_US.UTF-8\nENV LANG en_US.UTF-8\nENV LANGUAGE en_US.UTF-8\n# Use bash as default shell, rather than sh\nENV SHELL /bin/bash\n\nWORKDIR /code\n\nRUN pip3 install --no-cache-dir -U polyaxon-helper\nCOPY build /code\n",
"dockerfile": "\nFROM tensorflow/tensorflow:1.4.1-py3\n\nENV LC_ALL en_US.UTF-8\nENV LANG en_US.UTF-8\nENV LANGUAGE en_US.UTF-8\n# Use bash as default shell, rather than sh\nENV SHELL /bin/bash\n\nWORKDIR /code\n\nRUN pip3 install --no-cache-dir -U polyaxon-client\nCOPY build /code\n",
"commit": "2f758b8902d4cf5d4147b09706613ec108eda369",
"bookmarked": false
}
Expand Down
4 changes: 2 additions & 2 deletions docs/templates/polyaxon_rest/resources/experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ curl --request GET \
"build": {
"image": "tensorflow/tensorflow:1.4.1-py3",
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
]
},
"version": 1,
Expand Down Expand Up @@ -101,7 +101,7 @@ curl --request PATCH \
"build": {
"image": "tensorflow/tensorflow:1.4.1-py3",
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
]
},
"version": 1,
Expand Down
4 changes: 2 additions & 2 deletions docs/templates/polyaxon_rest/resources/experiment_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ curl -X GET \
"concurrency": 5,
"search_algorithm": "random",
"current_iteration": 0,
"content": "{'version': 1, 'kind': 'group', 'hptuning': {'concurrency': 5, 'random_search': {'n_experiments': 10}, 'matrix': {'learning_rate': {'linspace': '0.001:0.1:5'}, 'dropout': {'values': [0.25, 0.3]}, 'activation': {'values': ['relu', 'sigmoid']}}}, 'declarations': {'batch_size': 128, 'num_steps': 500, 'num_epochs': 1}, 'build': {'image': 'tensorflow/tensorflow:1.4.1-py3', 'build_steps': ['pip3 install --no-cache-dir -U polyaxon-helper']}, 'run': {'cmd': 'python3 model.py --batch_size={{ batch_size }} \\\\ --num_steps={{ num_steps }} \\\\ --learning_rate={{ learning_rate }} \\\\ --dropout={{ dropout }} \\\\ --num_epochs={{ num_epochs }} \\\\ --activation={{ activation }}'}}",
"content": "{'version': 1, 'kind': 'group', 'hptuning': {'concurrency': 5, 'random_search': {'n_experiments': 10}, 'matrix': {'learning_rate': {'linspace': '0.001:0.1:5'}, 'dropout': {'values': [0.25, 0.3]}, 'activation': {'values': ['relu', 'sigmoid']}}}, 'declarations': {'batch_size': 128, 'num_steps': 500, 'num_epochs': 1}, 'build': {'image': 'tensorflow/tensorflow:1.4.1-py3', 'build_steps': ['pip3 install --no-cache-dir -U polyaxon-client']}, 'run': {'cmd': 'python3 model.py --batch_size={{ batch_size }} \\\\ --num_steps={{ num_steps }} \\\\ --learning_rate={{ learning_rate }} \\\\ --dropout={{ dropout }} \\\\ --num_epochs={{ num_epochs }} \\\\ --activation={{ activation }}'}}",
"hptuning": {
"early_stopping": null,
"concurrency": 5,
Expand Down Expand Up @@ -114,7 +114,7 @@ curl -X PATCH \
"concurrency": 5,
"search_algorithm": "random",
"current_iteration": 0,
"content": "{'version': 1, 'kind': 'group', 'hptuning': {'concurrency': 5, 'random_search': {'n_experiments': 10}, 'matrix': {'learning_rate': {'linspace': '0.001:0.1:5'}, 'dropout': {'values': [0.25, 0.3]}, 'activation': {'values': ['relu', 'sigmoid']}}}, 'declarations': {'batch_size': 128, 'num_steps': 500, 'num_epochs': 1}, 'build': {'image': 'tensorflow/tensorflow:1.4.1-py3', 'build_steps': ['pip3 install --no-cache-dir -U polyaxon-helper']}, 'run': {'cmd': 'python3 model.py --batch_size={{ batch_size }} \\\\ --num_steps={{ num_steps }} \\\\ --learning_rate={{ learning_rate }} \\\\ --dropout={{ dropout }} \\\\ --num_epochs={{ num_epochs }} \\\\ --activation={{ activation }}'}}",
"content": "{'version': 1, 'kind': 'group', 'hptuning': {'concurrency': 5, 'random_search': {'n_experiments': 10}, 'matrix': {'learning_rate': {'linspace': '0.001:0.1:5'}, 'dropout': {'values': [0.25, 0.3]}, 'activation': {'values': ['relu', 'sigmoid']}}}, 'declarations': {'batch_size': 128, 'num_steps': 500, 'num_epochs': 1}, 'build': {'image': 'tensorflow/tensorflow:1.4.1-py3', 'build_steps': ['pip3 install --no-cache-dir -U polyaxon-client']}, 'run': {'cmd': 'python3 model.py --batch_size={{ batch_size }} \\\\ --num_steps={{ num_steps }} \\\\ --learning_rate={{ learning_rate }} \\\\ --dropout={{ dropout }} \\\\ --num_epochs={{ num_epochs }} \\\\ --activation={{ activation }}'}}",
"hptuning": {
"early_stopping": null,
"concurrency": 5,
Expand Down
10 changes: 5 additions & 5 deletions docs/templates/polyaxon_rest/resources/job.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ curl --request GET \
},
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand Down Expand Up @@ -95,7 +95,7 @@ curl --request PATCH \
},
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand Down Expand Up @@ -232,7 +232,7 @@ curl --request POST \
},
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand Down Expand Up @@ -286,7 +286,7 @@ curl --request POST \
},
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand Down Expand Up @@ -341,7 +341,7 @@ curl --request POST \
},
"build": {
"build_steps": [
"pip3 install --no-cache-dir -U polyaxon-helper"
"pip3 install --no-cache-dir -U polyaxon-client"
],
"image": "tensorflow/tensorflow:1.4.1-py3"
},
Expand Down
4 changes: 2 additions & 2 deletions docs/templates/polyaxonfile_specification/sections.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ For each experiment generated during the hyperparameters search, Polyaxon will a
to your declarations, and will export them under the environment variable name `POLYAXON_DECLARATIONS`.

!!! tip "Polyaxon append the matrix value combination to your declarations and export them under the environment variable name `POLYAXON_DECLARATIONS`"
Check how you can [get the cluster definition](/reference_polyaxon_helper) to use it with your models.
Check how you can [get the cluster definition](/tracking/experiments) to use it with your models.


### search algorithm: grid_search
Expand Down Expand Up @@ -766,7 +766,7 @@ The declaration are particularly important for descriptive models.
All your declaration will be exported under the environment variable name `POLYAXON_DECLARATIONS`.

!!! tip "Polyaxon export your declarations under environment variable name `POLYAXON_DECLARATIONS`"
Check how you can [get the experiment declarations](/reference_polyaxon_helper) to use them with your models.
Check how you can [get the experiment declarations](/tracking/experiments) to use them with your models.

## build

Expand Down
4 changes: 2 additions & 2 deletions docs/templates/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ And you are logged in to your Polyaxon account through the [polyaxon-cli](polyax
build:
image: tensorflow/tensorflow:1.4.1-py3
build_steps:
- pip3 install polyaxon-helper
- pip3 install polyaxon-client
run:
cmd: python model.py
Expand All @@ -90,7 +90,7 @@ And you are logged in to your Polyaxon account through the [polyaxon-cli](polyax
* The `project` namespace we want to run the experiment inside.
* The `build` section to build a docker image,
in this case we want to run our code with the specified tensorflow docker image.
We are also installing the [polyaxon helper](/reference_polyaxon_helper) library to send metrics at the end of the experiment.
We are also installing the polyaxon-client for [tracking](/tracking) and to send metrics at the end of the experiment.
* The `run` section to execute our code.
6. Now let's upload our code to create a commit on Polyaxon
Expand Down

0 comments on commit 2e32c06

Please sign in to comment.