Skip to content

New projects #906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/runai-submit-dist-TF.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ runai submit-dist tf --name distributed-job --workers=2 -g 1 \
#### --node-pools `<string>`

> Instructs the scheduler to run this workload using specific set of nodes which are part of a [Node Pool](../../Researcher/scheduling/the-runai-scheduler.md#). You can specify one or more node pools to form a prioritized list of node pools that the scheduler will use to find one node pool that can provide the workload's specification. To use this feature your Administrator will need to label nodes as explained here: [Limit a Workload to a Specific Node Group](../../admin/researcher-setup/limit-to-node-group.md) or use existing node labels, then create a node-pool and assign the label to the node-pool.
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/admin-ui-setup/project-setup.md).
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/aiinitiatives/org/projects.md).

#### --node-type `<string>`

Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/runai-submit-dist-mpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ You can start an unattended mpi training Job of name dist1, based on Project *te
#### --node-pools `<string>`

> Instructs the scheduler to run this workload using specific set of nodes which are part of a [Node Pool](../../Researcher/scheduling/the-runai-scheduler.md#). You can specify one or more node pools to form a prioritized list of node pools that the scheduler will use to find one node pool that can provide the workload's specification. To use this feature your Administrator will need to label nodes as explained here: [Limit a Workload to a Specific Node Group](../../admin/researcher-setup/limit-to-node-group.md) or use existing node labels, then create a node-pool and assign the label to the node-pool.
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/admin-ui-setup/project-setup.md).
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/admin-ui-setup/).

#### --node-type `<string>`

Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/runai-submit-dist-pytorch.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ runai submit-dist pytorch --name distributed-job --workers=2 -g 1 \
#### --node-pools `<string>`

> Instructs the scheduler to run this workload using specific set of nodes which are part of a [Node Pool](../../Researcher/scheduling/the-runai-scheduler.md#). You can specify one or more node pools to form a prioritized list of node pools that the scheduler will use to find one node pool that can provide the workload's specification. To use this feature your Administrator will need to label nodes as explained here: [Limit a Workload to a Specific Node Group](../../admin/researcher-setup/limit-to-node-group.md) or use existing node labels, then create a node-pool and assign the label to the node-pool.
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/admin-ui-setup/project-setup.md).
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/aiinitiatives/org/projects.md).

#### --node-type `<string>`

Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/runai-submit-dist-xgboost.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ runai submit-dist xgboost --name distributed-job --workers=2 -g 1 \
#### --node-pools `<string>`

> Instructs the scheduler to run this workload using specific set of nodes which are part of a [Node Pool](../../Researcher/scheduling/the-runai-scheduler.md#). You can specify one or more node pools to form a prioritized list of node pools that the scheduler will use to find one node pool that can provide the workload's specification. To use this feature your Administrator will need to label nodes as explained here: [Limit a Workload to a Specific Node Group](../../admin/researcher-setup/limit-to-node-group.md) or use existing node labels, then create a node-pool and assign the label to the node-pool.
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/admin-ui-setup/project-setup.md).
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/aiinitiatives/org/projects.md).

#### --node-type `<string>`

Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/runai-submit.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ runai submit --job-name-prefix -i gcr.io/run-ai-demo/quickstart -g 1
#### --node-pools `<string>`

> Instructs the scheduler to run this workload using specific set of nodes which are part of a [Node Pool](../../Researcher/scheduling/the-runai-scheduler.md#). You can specify one or more node pools to form a prioritized list of node pools that the scheduler will use to find one node pool that can provide the workload's specification. To use this feature your Administrator will need to label nodes as explained here: [Limit a Workload to a Specific Node Group](../../admin/researcher-setup/limit-to-node-group.md) or use existing node labels, then create a node-pool and assign the label to the node-pool.
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/admin-ui-setup/project-setup.md).
> This flag can be used in conjunction with node-type and Project-based affinity. In this case, the flag is used to refine the list of allowable node groups set from a node-pool. For more information see: [Working with Projects](../../admin/aiinitiatives/org/projects.md).

#### --node-type `<string>`

Expand Down
4 changes: 2 additions & 2 deletions docs/Researcher/scheduling/the-runai-scheduler.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Projects are quota entities that associate a Project name with a **deserved** GP

A Researcher submitting a workload must associate a Project with any workload request. The Run:ai scheduler will then compare the request against the current allocations and the Project's deserved quota and determine whether the workload can be allocated with resources or whether it should remain in a pending state.

For further information on Projects and how to configure them, see: [Working with Projects](../../admin/admin-ui-setup/project-setup.md)
For further information on Projects and how to configure them, see: [Working with Projects](../../admin/aiinitiatives/org/projects.md)

### Departments

A *Department* is the second hierarchy of resource allocation above *Project*. A Department quota supersedes a Project quota in the sense that if the sum of Project quotas for Department A exceeds the Department quota -- the scheduler will use the Department quota rather than the Projects' quota.

For further information on Departments and how to configure them, see: [Working with Departments](../../admin/admin-ui-setup/department-setup.md)
For further information on Departments and how to configure them, see: [Working with Departments](../../admin/aiinitiatives/org/departments.md)

### Pods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ date: 2024-Jan-7
A Workspace is assigned to a project and is affected by the project’s quota just like any other workload. A workspace is shared with all project members for collaboration.

!!! Note
* You must have at least one project configured in the system. To configure a project, see [Creating a project](../../../../admin/admin-ui-setup/project-setup.md#create-a-project).
* You must have at least one project configured in the system. To configure a project, see [Creating a project](../../../../admin/aiinitiatives/org/projects.md#adding-a-new-project).
* You must have at least 1 researcher assigned to the project.

Use the *Jobs form* below if you have not enabled the *Workloads* feature.
Expand Down
1 change: 0 additions & 1 deletion docs/admin/admin-ui-setup/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Run:ai provides a single user interface that, depending on your role, serves bot
The control-plane part of the tool allows the administrator to:

* Analyze cluster status using [dashboards](dashboard-analysis.md).
* Manage Run:ai metadata such as [users](admin-ui-users.md), [departments](department-setup.md), and [projects](project-setup.md).
* View Job details to be able to help researchers solve Job-related issues.

The researcher workbench part of the tool allows Researchers to submit, delete and pause [Jobs](jobs.md), view Job logs etc.
Expand Down
Loading
Loading