add chainer to the website. #200
Conversation
everpeace
changed the title
| parent = "components" | ||
| weight = 30 | ||
| +++ | ||
|
|
There was a problem hiding this comment.
I would suggest adding an explanation of what Chainer is.
| ks apply ${ENVIRONMENT} -c chainer-operator | ||
| ``` | ||
|
|
||
| ## Creating an Chainer Job |
| You can create an Chainer Job by defining an ChainerJob config file. See [examples/chainerjob-reference.yaml](https://github.com/kubeflow/chainer-operator/blob/master/examples/chainerjob-reference.yaml) config file. You may change the config file based on your requirements. By default, the example job is distributed learning with 3 nodes (1 master, 2 workers). | ||
|
|
||
| ```shell | ||
| cat examples/chainerjob-reference.yaml |
There was a problem hiding this comment.
This command doesn't seem very helpful because people won't have checked out the chainer repository.
I'd suggest just telling people to download/copy paste the link you provided above.
There was a problem hiding this comment.
You could also just past the YAML spec into the markdown doc and tell people to copy paste it.
|
@everpeace please address jlewi's comments. |
|
@abhi-g sorry, I'll fix this PR today (I'm in tokyo). |
|
@jlewi Hi, I fixed chainer document according to your comments. PTAL again. Thanks in advance. Please see my comments about the ordering of chainer document on the sidebar: #200 (comment) |
everpeace
force-pushed
the
add-chainer
branch
from
884d8f4 to
40169da
Compare
everpeace
force-pushed
the
add-chainer
branch
from
40169da to
00c75d3
Compare
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abhi-g The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@everpeace I just noticed that the PR merges the chainer docs to v0.2-branch. Since this is going to be available only 0.3.0 onwards, can you please instead merge this into master. I don't think it makes sense to have the Chainer component doc in 0.2 site if the component itself is not available with that release. |
|
@abhi-g oh, ok. I will open another PR to master branch. |
|
@abhi-g should I revert this PR?? |
fixes kubeflow/chainer-operator#23
This change is