Skip to content
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

Update links in README.md #3

Merged
merged 1 commit into from
Jul 23, 2017
Merged
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ K8s makes it easy to configure and deploy each set of TF replicas. Various tools


TfJob provides a K8s resource representing a single, distributed, TensorFlow job.
The Spec and Status (defined in [tf_job.go](https://cloud-ml.googlesource.com/jlewi-training/+/tpr/pkg/spec/tf_job.go))
The Spec and Status (defined in [tf_job.go](https://github.com/jlewi/mlkube.io/blob/master/pkg/spec/tf_job.go))
are customized for TensorFlow. The spec allows specifying the Docker image and arguments to use for each TensorFlow
replica (i.e. master, worker, and parameter server). The status provides relevant information such as the number of
replicas in various states.
Expand All @@ -46,7 +46,7 @@ example-job TfJob.v1beta1.mlkube.io

The code is closely modeled on Coreos's [etcd-operator](https://github.com/coreos/etcd-operator).

The TfJob Spec(defined in [tf_job.go](https://cloud-ml.googlesource.com/jlewi-training/+/tpr/pkg/spec/tf_job.go))
The TfJob Spec(defined in [tf_job.go](https://github.com/jlewi/mlkube.io/blob/master/pkg/spec/tf_job.go))
reuses the existing Kubernetes structure PodTemplateSpec to describe TensorFlow processes.
We use PodTemplateSpec because we want to make it easy for users to
configure the processes; for example setting resource requirements or adding volumes.
Expand All @@ -61,7 +61,7 @@ Leader election allows a K8s deployment resource to be used to upgrade the opera
1. Clone the repository

```
git clone https://cloud-ml.googlesource.com/jlewi-training
git clone https://github.com/jlewi/mlkube.io/
```

1. Deploy the operator
Expand Down Expand Up @@ -186,7 +186,7 @@ Create a symbolic link inside your GOPATH to the location you checked out the co
ln -sf ${GIT_TRAINING}/src/mlkube.io ${GOPATH}/src/
```

* GIT_TRAINING should be the location where you checked out https://cloud-ml.googlesource.com/training/
* GIT_TRAINING should be the location where you checked out https://github.com/jlewi/mlkube.io

Build it

Expand Down