Skip to content

Commit e997657

Browse files
authored
Fixed llm docs. (#520)
2 parents f04a4a6 + 27faedf commit e997657

File tree

6 files changed

+21
-27
lines changed

6 files changed

+21
-27
lines changed

.github/workflows/run-unittests-default_setup.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@ name: "[Py3.8][Py3.9][Py3.10] tests/unitary/default_setup/**"
22

33
on:
44
workflow_dispatch:
5+
push:
56
pull_request:
6-
paths:
7-
- "ads/**"
8-
- pyproject.toml
9-
- "**requirements.txt"
10-
- ".github/workflows/run-unittests*.yml"
7+
types: [opened, reopened]
8+
branches: [ "main" ]
119

1210
# Cancel in progress workflows on pull_requests.
1311
# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value

.github/workflows/run-unittests-py38-cov-report.yml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@ name: "[Py3.8][COV REPORT] tests/unitary/**"
22

33
on:
44
workflow_dispatch:
5+
push:
56
pull_request:
6-
paths:
7-
- "ads/**"
8-
- pyproject.toml
9-
- "**requirements.txt"
10-
- ".github/workflows/run-unittests*.yml"
7+
types: [opened, reopened]
8+
branches: [ "main" ]
119

1210
# Cancel in progress workflows on pull_requests.
1311
# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
@@ -116,7 +114,7 @@ jobs:
116114
runs-on: ubuntu-latest
117115
continue-on-error: true
118116
needs: test
119-
if: ${{ success() }} && && github.event_name == 'pull_request'
117+
if: ${{ success() }} && github.event_name == 'pull_request'
120118
env:
121119
COMPARE_BRANCH: main
122120

@@ -155,7 +153,6 @@ jobs:
155153
fi
156154
157155
- name: "Calculate coverage diff"
158-
if: always()
159156
run: |
160157
set -x # print commands that are executed
161158
@@ -186,7 +183,7 @@ jobs:
186183
187184
- name: "Add comment with cov diff to PR"
188185
uses: actions/github-script@v6
189-
if: always()
186+
if: github.event_name == 'pull_request'
190187
with:
191188
github-token: ${{ github.token }}
192189
script: |

.github/workflows/run-unittests-py39-py310.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@ name: "[Py3.9][Py3.10] - tests/unitary/**"
22

33
on:
44
workflow_dispatch:
5+
push:
56
pull_request:
6-
paths:
7-
- "ads/**"
8-
- pyproject.toml
9-
- "**requirements.txt"
10-
- ".github/workflows/run-unittests*.yml"
7+
types: [opened, reopened]
8+
branches: [ "main" ]
119

1210
# Cancel in progress workflows on pull_requests.
1311
# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. admonition:: Distributed Training with OCI Data Science
2+
:class: note
3+
4+
You need to configure your `networking <https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/overview.htm>`_
5+
and `IAM <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/overview.htm>`_ policies.
6+
We recommend running the training on a private subnet.
7+
In this example, internet access is needed to download the source code and the pre-trained model.

docs/source/user_guide/jobs/tabs/run_job.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To create and start running the job:
1313
run.watch()
1414

1515
.. code-tab:: bash
16-
:caption: YAML
16+
:caption: CLI
1717

1818
# Use the following command to start the job run
1919
ads opctl run -f your_job.yaml

docs/source/user_guide/large_language_model/training_llm.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,9 @@ Oracle Cloud Infrastructure (OCI) `Data Science Jobs (Jobs) <https://docs.oracle
77
provides fully managed infrastructure to enable training large language model at scale.
88
This page shows an example of fine-tuning the `Llama 2 <https://ai.meta.com/llama/>`_ model. For model details on the APIs, see :doc:`../jobs/run_pytorch_ddp`.
99

10-
.. admonition:: Distributed Training with OCI Data Science
11-
:class: note
10+
.. include:: ../_template/distributed_training_policies.rst
1211

13-
You need to configure your `networking <https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/overview.htm>`_
14-
and `IAM <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/overview.htm>`_ policies.
15-
We recommend running the training on a private subnet.
16-
In this example, internet access is needed to download the source code and the pre-trained model.
17-
18-
The `llama-recipes <llama-recipes>`_ repository contains example code to fine-tune llama2 model.
12+
The `llama-recipes <https://github.com/facebookresearch/llama-recipes>`_ repository contains example code to fine-tune llama2 model.
1913
The example `fine-tuning script <https://github.com/facebookresearch/llama-recipes/blob/1aecd00924738239f8d86f342b36bacad180d2b3/examples/finetuning.py>`_ supports both full parameter fine-tuning
2014
and `Parameter-Efficient Fine-Tuning (PEFT) <https://huggingface.co/blog/peft>`_.
2115
With ADS, you can start the training job by taking the source code directly from Github with no code change.

0 commit comments

Comments
 (0)