Skip to content

Commit

Permalink
rename to mlcommons
Browse files Browse the repository at this point in the history
  • Loading branch information
sub-mod committed Nov 30, 2020
1 parent 39d63f5 commit 3374539
Show file tree
Hide file tree
Showing 14 changed files with 30 additions and 30 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The mkdocs action builds and deploys the documentation site into the `gh-pages`

### How it works

The [mlcube repo](https://github.com/mlperf/mlcube) has Pull Requests pushed into the `master` branch on every merge. So the event associated with every PR merge is a `event:push`.
The [mlcube repo](https://github.com/mlcommons/mlcube) has Pull Requests pushed into the `master` branch on every merge. So the event associated with every PR merge is a `event:push`.

So the `docs-site` GitHub Action is triggered on every push into the repo.

Expand Down Expand Up @@ -57,4 +57,4 @@ In order to not fill-up space on the repo with the docs-site related files, the

- Permissions

The `docs-site` GitHub Action uses a deploy key specifically created for it. To revoke access to the GitHub Action, delete the secret `ACTIONS_DEPLOY_KEY` in [Repository Settings](https://github.com/mlperf/mlcube/settings/secrets/).
The `docs-site` GitHub Action uses a deploy key specifically created for it. To revoke access to the GitHub Action, delete the secret `ACTIONS_DEPLOY_KEY` in [Repository Settings](https://github.com/mlcommons/mlcube/settings/secrets/).
2 changes: 1 addition & 1 deletion .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ jobs:
uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.MLCOMMONS_REPO_ACCESS }}
repository: mlperf/mlcube
repository: mlcommons/mlcube
event-type: publish-runners
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to MLCube

Thank you for your interest in contributing to MLCube! The best way to get started is to make sure you signed the
Google CLA (https://cla.developers.google.com/clas), soon to be replaced by a mlperf/mlcube CLA.
Google CLA (https://cla.developers.google.com/clas), soon to be replaced by a mlcommons/mlcube CLA.

- If you are making a trivial cange (such as a typo fix), please feel free create a PR once you have signed the CLA.
- For larger changes, please join our mailing list https://groups.google.com/g/mlperf-best-practices and/or slack http://mlperf.slack.com/ to discuss.
- For larger changes, please join our mailing list https://groups.google.com/g/mlcommons-best-practices and/or slack http://mlcommons.slack.com/ to discuss.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ pip uninstall mlcube

## Usage Examples

Check out the [examples](https://github.com/mlperf/mlcube_examples) for detailed examples and [MLCube wiki](https://mlcommons.github.io/mlcube).
Check out the [examples](https://github.com/mlcommons/mlcube_examples) for detailed examples and [MLCube wiki](https://mlcommons.github.io/mlcube).

## License
[MLCube](https://github.com/mlperf/mlcube/) is licensed under the Apache License 2.0.
[MLCube](https://github.com/mlcommons/mlcube/) is licensed under the Apache License 2.0.

See [LICENSE](https://github.com/mlperf/mlcube/blob/master/LICENSE) for more information.
See [LICENSE](https://github.com/mlcommons/mlcube/blob/master/LICENSE) for more information.

## Support

[Create a GitHub issue](https://github.com/mlperf/mlcube/issues/new/choose)
[Create a GitHub issue](https://github.com/mlcommons/mlcube/issues/new/choose)
2 changes: 1 addition & 1 deletion docs/getting-started/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pip install mlcube-docker
### Run Hello World MLCube example
```
# hello_world MLCube is present in mlcube_examples repo.
git clone https://github.com/mlperf/mlcube_examples.git && cd ./mlcube_examples/hello_world
git clone https://github.com/mlcommons/mlcube_examples.git && cd ./mlcube_examples/hello_world
Run Hello World MLCube on a local machine with Docker runner
# Configure Hello World MLCube
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pip install mlcube-docker

## Explore with examples
```
git clone https://github.com/mlperf/mlcube_examples.git && cd ./mlcube_examples
git clone https://github.com/mlcommons/mlcube_examples.git && cd ./mlcube_examples
```
A great way to learn about MLCube is try out the example MLCube cubes located [here](https://github.com/mlperf/mlcube_examples).
A great way to learn about MLCube is try out the example MLCube cubes located [here](https://github.com/mlcommons/mlcube_examples).

6 changes: 3 additions & 3 deletions docs/getting-started/mnist.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ the following:
schema_version: 1.0.0
schema_type: mlcube_docker
image: mlperf/mlcube:mnist # Docker image name
image: mlcommons/mlcube:mnist # Docker image name
docker_runtime: docker # Docker executable: docker or nvidia-docker
```
Expand All @@ -259,7 +259,7 @@ Singularity platform configuration is the following:
schema_version: 1.0.0
schema_type: mlcube_singularity
image: /opt/singularity/mlperf_mlcube_mnist-0.01.simg # Path to or name of a Singularity image.
image: /opt/singularity/mlcommons_mlcube_mnist-0.01.simg # Path to or name of a Singularity image.
```
At this point, the cube directory looks like:
```
Expand Down Expand Up @@ -334,7 +334,7 @@ mlcube_docker run --mlcube=. --platform=platforms/docker.yaml --task=run/train.y
### Singularity Runner
Update path to store Singularity image. Open `platforms/singularity.yaml` and update the `image` value
that is set by default to `/opt/singularity/mlperf_mlcube_mnist-0.01.simg` (relative paths are supported, they are
that is set by default to `/opt/singularity/mlcommons_mlcube_mnist-0.01.simg` (relative paths are supported, they are
relative to `workspace`).
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ pip uninstall mlcube

## Usage Examples

Check out the [examples](https://github.com/mlperf/mlcube_examples) for detailed examples.
Check out the [examples](https://github.com/mlcommons/mlcube_examples) for detailed examples.

## License
[MLCube](https://github.com/mlperf/mlcube/) is licensed under the Apache License 2.0.
[MLCube](https://github.com/mlcommons/mlcube/) is licensed under the Apache License 2.0.

See [LICENSE](https://github.com/mlperf/mlcube/blob/master/LICENSE) for more information.
See [LICENSE](https://github.com/mlcommons/mlcube/blob/master/LICENSE) for more information.

## Support

[Create a GitHub issue](https://github.com/mlperf/mlcube/issues/new/choose)
[Create a GitHub issue](https://github.com/mlcommons/mlcube/issues/new/choose)
2 changes: 1 addition & 1 deletion docs/runners/docker-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ reference MNIST cube is the following:
schema_version: 1.0.0
schema_type: mlcube_docker

image: mlperf/mlcube:mnist # Docker image name
image: mlcommons/mlcube:mnist # Docker image name
docker_runtime: docker # Docker executable: docker or nvidia-docker
```
Expand Down
4 changes: 2 additions & 2 deletions docs/runners/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ platform:
name: "docker"
version: ">=18.01"
container:
image: "mlperf/mlcube:mnist"
image: "mlcommons/mlcube:mnist"
```
With these two config files, the runner then constructs the following Kubernetes Job manifest.
Expand All @@ -71,7 +71,7 @@ spec:
spec:
containers:
- name: mlcube-container
image: mlperf/mlcube:mnist
image: mlcommons/mlcube:mnist
args:
- --data_dir=/mnt/mlcube/mlcube-input/workspace/data
- --model_dir=/mnt/mlcube/mlcube-output/workspace/model
Expand Down
2 changes: 1 addition & 1 deletion docs/runners/singularity-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ file for the reference MNIST cube is the following:
schema_version: 1.0.0
schema_type: mlcube_singularity

image: /opt/singularity/mlperf_mlcube_mnist-0.01.simg # Path to or name of a Singularity image.
image: /opt/singularity/mlcommons_mlcube_mnist-0.01.simg # Path to or name of a Singularity image.
```
The `image` field above is a path to a singularity container. It is relative to `{MLCUBE_ROOT}/workspace`:
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: 'MLCube'
site_description: 'Documentation site for MLCube'
site_author: '<MLPerf.org> mlperf@googlegroups.com'
site_author: '<MLPerf.org> mlcommons@googlegroups.com'
docs_dir: 'docs/'

nav:
Expand Down
10 changes: 5 additions & 5 deletions release_tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@


Hard requirements:
1. Versions of all projects must be the same, e.g. 0.2.3. This applies to [mlcube](https://github.com/mlperf/mlcube/tree/master/mlcube)
and to all [runners](https://github.com/mlperf/mlcube/tree/master/runners).
1. Versions of all projects must be the same, e.g. 0.2.3. This applies to [mlcube](https://github.com/mlcommons/mlcube/tree/master/mlcube)
and to all [runners](https://github.com/mlcommons/mlcube/tree/master/runners).
2. All runners depend on mlcube library. Version in each requirements.txt file must equal and be the version of
current release. If current release version is 0.2.3, then all runners must specify mlcube==0.2.3 in their
respective requirements files.
Expand All @@ -16,8 +16,8 @@ Check list before making a new release:
1. Figure out the version of the [last release](https://pypi.org/project/mlcube/) and make sure the current
version has been set to the right value for all projects and their dependencies. All package versions and their
dependencies must be the same (== current release version). Check the following:
- MLCube version in [setup.py](https://github.com/mlperf/mlcube/blob/master/mlcube/setup.py).
- For [each runner](https://github.com/mlperf/mlcube/tree/master/runners) check their setup.py and requirements.txt
- MLCube version in [setup.py](https://github.com/mlcommons/mlcube/blob/master/mlcube/setup.py).
- For [each runner](https://github.com/mlcommons/mlcube/tree/master/runners) check their setup.py and requirements.txt
files.
2. Projects' unit tests. They run for each PR, so it is assumed all init tests are OK.
3. Run extended (release) unit tests for each runner. This requires special software stack, such as docker or
Expand All @@ -39,7 +39,7 @@ Proposed semi-automated workflow:
4. If something fails, fix and go to #3.
5. If updates are required, commit, push and create a new PR. Once merged, repeat all steps above.
6. Make a GitHub release (what will also push packages to PyPi):
- Go to MLCube GitHub [repo](https://github.com/mlperf/mlcube) and click [Releases](https://github.com/mlperf/mlcube/releases)
- Go to MLCube GitHub [repo](https://github.com/mlcommons/mlcube) and click [Releases](https://github.com/mlcommons/mlcube/releases)
that you should see on the right, below the `About` section. If no `Releases` link is available, that probably
means a user does not have appropriate rights to create releases.
- Click `Draft a new release`.
Expand Down
2 changes: 1 addition & 1 deletion runners/mlcube_k8s/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Kubernetes Runner

[Documentation](https://mlperf.github.io/mlcube/runners/kubernetes/)
[Documentation](https://mlcommons.github.io/mlcube/runners/kubernetes/)

0 comments on commit 3374539

Please sign in to comment.