Commit b84ec274 authored by Paul Bethge's avatar Paul Bethge
Browse files

Update README.md

parent b7a149f5
Pipeline #183 failed with stage
......@@ -14,22 +14,19 @@ To run pipelines on our AI Server you need to:
2. Select Settings > CI/CD on the left sidebar.
3. Expand Runners > Shared Runners and select "Enable shared runners for this project".
## Submitting a CPU Job
## Submitting a Job
You can use the CI/CD pipeline to submit a job that gets picked up by a GitLab Runner and is executed in a container on our AI Server. To view available runners, go to `Settings` > `CI/CD` and expand `Runners`.
In order to specify a job and its environment you need to have the `.gitlab-ci.yml` in the top-level of your repository.
The pipeline runs every time changes are pushed to any branch in the project.
By default, the pipeline runs every time changes are pushed to any branch in the project.
```yaml
my-first-job:
image: ubuntu:18.04
script:
- echo "here could be your executable"
tags:
- docker
- cpu
```
## Minimal CPU Job
## A simple job
#### Jobs
In this file, you define the structure and order of jobs that the runner should execute.
Jobs are defined as entries at the top-level and should not interfere with keywords, here: `my-first-job`.
......@@ -45,16 +42,15 @@ __NOTE__: please use images uploaded to https://harbor.zkm.de/.
With the `script` constraint you can run any executable that is available in either the container or the repository.
Imagine the scripts you add to jobs are the same as CLI commands you run on your computer. A Job has to have at least on item in script.
#### Tags
Using the `tags` constraint we define which Runner will be chosen to run your code.
For running the job on the CPU use:
#### Tags and Runners
Using the `tags` constraint we define which Runner will be chosen to run your code. Currently, we have two Runners for the AI Server.
For simple jobs and testing, please use the CPU Runner, which is called by specifying the following tags:
```yaml
tags:
- docker
- cpu
```
## View the state of the pipeline
To see the history of all submitted pipeline go to `CI/CD` > `Pipelines` on the left side. Here you will find most useful information of your current and passed pipelines.
![](media/pipeline.png)
......@@ -71,7 +67,7 @@ my-first-gpu-job:
image: tensorflow/tensorflow:devel-gpu
script:
- echo "here could be your executable"
- nvidia-smi
- nvidia-smi
tags:
- docker
- gpu
......@@ -80,10 +76,18 @@ my-first-gpu-job:
__NOTE:__ Please be mindful of the resources you use. For complex or long running jobs we recommend triggering your training or other pipelines manually so that you only use the ressource wenn actually needed. Use the CPU runner(s) if no GPU access is required.
## Other useful constraints
check the usage of additional constraints in the [reference guide](https://docs.gitlab.com/ee/ci/yaml/index.html)
- _stage_:
You can check the usage of additional constraints in the [reference guide](https://docs.gitlab.com/ee/ci/yaml/index.html). Below are some neet tricks to add to your CI pipeline.
##### rules
Specify when to trigger the pipeline. For example, you can disable the automatic triggering on push by adding:
```yaml
rules:
- when: manual
```
##### stage:
You can group multiple independent jobs into stages that run in a defined order.
- only
##### TODO
- parallel
- resource_group
- services
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment