Skip to content

Commit

Permalink
Rename Kubeflow Training to Kubeflow Trainer
Browse files Browse the repository at this point in the history
Signed-off-by: Andrey Velichkevich <[email protected]>
  • Loading branch information
andreyvelich committed Jan 17, 2025
1 parent bebacdc commit 2996292
Show file tree
Hide file tree
Showing 17 changed files with 85 additions and 102 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Bug Report
description: Tell us about a problem you are experiencing with Training Operator
description: Tell us about a problem you are experiencing with Kubeflow Trainer
labels: ["kind/bug", "lifecycle/needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this Training Operator bug report!
Thanks for taking the time to fill out this Kubeflow Trainer bug report!
- type: textarea
id: problem
attributes:
Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
blank_issues_enabled: true

contact_links:
- name: Training Operator Documentation
url: https://www.kubeflow.org/docs/components/training/
- name: Kubeflow Trainer Documentation
url: https://www.kubeflow.org/docs/components/trainer/
about: Much help can be found in the docs
- name: Kubeflow Training Operator Slack Channel
- name: Kubeflow Trainer Slack Channel
url: https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels
about: Ask the Training Operator community on CNCF Slack
- name: Kubeflow Training Operator Community Meeting
about: Ask the Kubeflow Trainer community on CNCF Slack
- name: Kubeflow Training and AutoML WG Community Meeting
url: https://bit.ly/2PWVCkV
about: Join the Kubeflow Training working group meeting
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
name: Feature Request
description: Suggest an idea for Training Operator
description: Suggest an idea for Kubeflow Trainer
labels: ["kind/feature", "lifecycle/needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this Training Operator feature request!
Thanks for taking the time to fill out this Kubeflow Trainer feature request!
- type: textarea
id: feature
attributes:
label: What you would like to be added?
description: |
A clear and concise description of what you want to add to Training Operator.
Please consider to write Training Operator enhancement proposal if it is a large feature request.
A clear and concise description of what you want to add to Kubeflow Trainer.
Please consider to write Kubeflow Enhancement Proposal (KEP) if it is a large feature request.
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Fixes #

**Checklist:**

- [ ] [Docs](https://www.kubeflow.org/docs/components/training/) included if any changes are user facing
- [ ] [Docs](https://www.kubeflow.org/docs/components/trainer/) included if any changes are user facing
5 changes: 0 additions & 5 deletions .github/issue_label_bot.yaml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish Kubeflow Trainer Images
name: Build and Publish Images

on:
- push
Expand Down
File renamed without changes.
File renamed without changes.
14 changes: 0 additions & 14 deletions .github/workflows/pre-commit.yaml

This file was deleted.

57 changes: 0 additions & 57 deletions .github/workflows/setup-e2e-test/action.yaml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
name: Free-Up Disk Space
description: Remove Non-Essential Tools And Move Docker Data Directory to /mnt/docker
# TODO (andreyvelich): Refactor this once we have e2e test for Kubeflow Trainer.
name: Setup E2E test template
description: A composite action to setup e2e tests

inputs:
kubernetes-version:
required: true
description: Kubernetes version
python-version:
required: true
description: Python version
gang-scheduler-name:
required: false
default: "none"
description: Gang scheduler name

runs:
using: composite
Expand Down Expand Up @@ -47,3 +60,40 @@ runs:
sudo systemctl start docker
echo "Docker service status:"
sudo systemctl --no-pager -l -o short status docker
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ inputs.python-version }}

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod

- name: Create k8s Kind Cluster
uses: helm/[email protected]
with:
node_image: kindest/node:${{ inputs.kubernetes-version }}
cluster_name: training-operator-cluster
kubectl_version: ${{ inputs.kubernetes-version }}

- name: Build training-operator
shell: bash
run: |
./scripts/gha/build-image.sh
env:
TRAINING_CI_IMAGE: kubeflowtraining/training-operator:test

- name: Deploy training operator
shell: bash
run: |
./scripts/gha/setup-training-operator.sh
docker system prune -a -f
docker system df
df -h
env:
KIND_CLUSTER: training-operator-cluster
TRAINING_CI_IMAGE: kubeflowtraining/training-operator:test
GANG_SCHEDULER_NAME: ${{ inputs.gang-scheduler-name }}
KUBERNETES_VERSION: ${{ inputs.kubernetes-version }}
2 changes: 1 addition & 1 deletion .github/workflows/template-publish-image/action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ inputs:
description: whether to push container images or not
tag-prefix:
required: false
default: v1
default: v2alpha1
description: Prefix for the image tag, e.g. v2alpha1

runs:
Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/test-python.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ on:
- pull_request

jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: pre-commit/[email protected]

python-test:
name: Test
runs-on: ubuntu-latest
Expand Down
6 changes: 4 additions & 2 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Adopters of Kubeflow Training Operator
# Adopters of Kubeflow Trainer

This page contains a list of organizations who are using Kubeflow Training Operator. If you'd like to be included here, please send a pull request which modifies this file. Please keep the list in alphabetical order.
This page contains a list of organizations who are using Kubeflow Trainer.
If you'd like to be included here, please send a pull request which modifies this file.
Please keep the list in alphabetical order.

| Organization | Contact |
| ------------ | ------- |
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following KubeCon + CloudNativeCon 2024 talk provides an overview of Kubeflo

## Getting Started

Please check [the official Kubeflow documentation](https://www.kubeflow.org/docs/components/training/getting-started)
Please check [the official Kubeflow documentation](https://www.kubeflow.org/docs/components/trainer/getting-started)
to install and get started with Kubeflow Trainer.

## Community
Expand All @@ -38,7 +38,7 @@ The following links provide information on how to get involved in the community:

- Join our [`#kubeflow-training` Slack channel](https://www.kubeflow.org/docs/about/community/#kubeflow-slack).
- Attend [the bi-weekly AutoML and Training Working Group](https://bit.ly/2PWVCkV) community meeting.
- Check out [who is using the Training Operator](ADOPTERS.md).
- Check out [who is using Kubeflow Trainer](ADOPTERS.md).

## Contributing

Expand All @@ -51,12 +51,12 @@ Please refer to the [CHANGELOG](CHANGELOG.md).
## Kubeflow Training Operator V1

Kubeflow Trainer project is currently in <strong>alpha</strong> status, and APIs may change.
If you are using Kubeflow Training Operator V1, please refer [to this migration document](/docs/components/training/operator-guides/migration).
If you are using Kubeflow Training Operator V1, please refer [to this migration document](/docs/components/trainer/operator-guides/migration).

Kubeflow Community will maintain the Training Operator V1 source code at
[the `release-1.9` branch](https://github.com/kubeflow/training-operator/tree/release-1.9).

You can find the documentation for Kubeflow Training V1 in [these guides](https://www.kubeflow.org/docs/components/training/legacy-v1).
You can find the documentation for Kubeflow Training Operator V1 in [these guides](https://www.kubeflow.org/docs/components/trainer/legacy-v1).

## Acknowledgement

Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Training Operator Documentation
# Kubeflow Trainer Documentation

Welcome to Kubeflow Training Operator!
Welcome to Kubeflow Trainer!

The Training Operator documentation is available on [kubeflow.org](https://www.kubeflow.org/docs/components/training/).
The Kubeflow Trainer documentation is available on [kubeflow.org](https://www.kubeflow.org/docs/components/trainer/).
2 changes: 1 addition & 1 deletion sdk_v2/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ dependencies = [

[project.urls]
Homepage = "https://github.com/kubeflow/training-operator"
Documentation = "https://www.kubeflow.org/docs/components/training/"
Documentation = "https://www.kubeflow.org/docs/components/trainer/"
Source = "https://github.com/kubeflow/training-operator"

[tool.hatch.build.targets.wheel]
Expand Down

0 comments on commit 2996292

Please sign in to comment.