You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@submarine.apache.org by GitBox <gi...@apache.org> on 2021/07/12 19:46:54 UTC
[GitHub] [submarine] ByronHsu opened a new pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
ByronHsu opened a new pull request #664:
URL: https://github.com/apache/submarine/pull/664
### What is this PR for?
Write an example that will walk users through the end-to-end usage of the submarine.
### What type of PR is it?
[Documentation]
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-928
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #664:
URL: https://github.com/apache/submarine/pull/664#discussion_r672824433
##########
File path: dev-support/examples/quickstart/build.sh
##########
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euxo pipefail
+
+SUBMARINE_VERSION=0.6.0-SNAPSHOT
+SUBMARINE_IMAGE_NAME="quickstart:${SUBMARINE_VERSION}"
Review comment:
I think it could be changed to `apache/submarine:quickstart-${SUBMARINE_VERSION}`,
and we could build and deploy to the submarine docker hub.
https://github.com/apache/submarine/blob/master/.github/workflows/deploy_docker_images.yml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #664:
URL: https://github.com/apache/submarine/pull/664#discussion_r672824433
##########
File path: dev-support/examples/quickstart/build.sh
##########
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euxo pipefail
+
+SUBMARINE_VERSION=0.6.0-SNAPSHOT
+SUBMARINE_IMAGE_NAME="quickstart:${SUBMARINE_VERSION}"
Review comment:
I think it could be changed to `apache/submarine:quickstart-${SUBMARINE_VERSION}`,
and we could build and deploy to the submarine docker hub.
https://github.com/apache/submarine/blob/master/.github/workflows/deploy_docker_images.yml
##########
File path: dev-support/examples/quickstart/build.sh
##########
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euxo pipefail
+
+SUBMARINE_VERSION=0.6.0-SNAPSHOT
+SUBMARINE_IMAGE_NAME="quickstart:${SUBMARINE_VERSION}"
Review comment:
I think it could be changed to `apache/submarine:quickstart-${SUBMARINE_VERSION}`,
and we could build the image and deploy it to the submarine docker hub.
https://github.com/apache/submarine/blob/master/.github/workflows/deploy_docker_images.yml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #664:
URL: https://github.com/apache/submarine/pull/664#discussion_r672824433
##########
File path: dev-support/examples/quickstart/build.sh
##########
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euxo pipefail
+
+SUBMARINE_VERSION=0.6.0-SNAPSHOT
+SUBMARINE_IMAGE_NAME="quickstart:${SUBMARINE_VERSION}"
Review comment:
I think it could be changed to `apache/submarine:quickstart-${SUBMARINE_VERSION}`,
and we could build the image and deploy it to the submarine docker hub.
https://github.com/apache/submarine/blob/master/.github/workflows/deploy_docker_images.yml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
pingsutw commented on pull request #664:
URL: https://github.com/apache/submarine/pull/664#issuecomment-886167759
@ByronHsu Could you fix the conflict? Thanks!!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] asfgit closed pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #664:
URL: https://github.com/apache/submarine/pull/664
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #664:
URL: https://github.com/apache/submarine/pull/664#discussion_r672824433
##########
File path: dev-support/examples/quickstart/build.sh
##########
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euxo pipefail
+
+SUBMARINE_VERSION=0.6.0-SNAPSHOT
+SUBMARINE_IMAGE_NAME="quickstart:${SUBMARINE_VERSION}"
Review comment:
I think it could be changed to `apache/submarine:quickstart-${SUBMARINE_VERSION}`,
and we could build and deploy to the submarine docker hub.
https://github.com/apache/submarine/blob/master/.github/workflows/deploy_docker_images.yml
##########
File path: dev-support/examples/quickstart/build.sh
##########
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euxo pipefail
+
+SUBMARINE_VERSION=0.6.0-SNAPSHOT
+SUBMARINE_IMAGE_NAME="quickstart:${SUBMARINE_VERSION}"
Review comment:
I think it could be changed to `apache/submarine:quickstart-${SUBMARINE_VERSION}`,
and we could build the image and deploy it to the submarine docker hub.
https://github.com/apache/submarine/blob/master/.github/workflows/deploy_docker_images.yml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] asfgit closed pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #664:
URL: https://github.com/apache/submarine/pull/664
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] kevin85421 commented on a change in pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
kevin85421 commented on a change in pull request #664:
URL: https://github.com/apache/submarine/pull/664#discussion_r668409981
##########
File path: website/docs/gettingStarted/quickstart.md
##########
@@ -0,0 +1,189 @@
+---
+title: Quickstart
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+This document gives you a quick view on the basic usage of Submarine platform. You can finish each steps of ML model lifecycle on the platform without messing up with the troublesome environment problems.
Review comment:
"each step" vs "each steps"
https://textranch.com/356483/each-step/or/each-steps/
##########
File path: website/docs/gettingStarted/quickstart.md
##########
@@ -0,0 +1,189 @@
+---
+title: Quickstart
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+This document gives you a quick view on the basic usage of Submarine platform. You can finish each steps of ML model lifecycle on the platform without messing up with the troublesome environment problems.
+
+## Installation
+
+### Prepare a Kubernetes cluster
+
+1. Prerequisite
+
+- Check dependency page for the compatible version
Review comment:
Add a hyperlink
https://github.com/apache/submarine/blob/master/website/docs/devDocs/Dependencies.md
##########
File path: website/docs/gettingStarted/quickstart.md
##########
@@ -0,0 +1,189 @@
+---
+title: Quickstart
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+This document gives you a quick view on the basic usage of Submarine platform. You can finish each steps of ML model lifecycle on the platform without messing up with the troublesome environment problems.
+
+## Installation
+
+### Prepare a Kubernetes cluster
+
+1. Prerequisite
+
+- Check dependency page for the compatible version
+- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
+- [helm](https://helm.sh/docs/intro/install/) (Helm v3 is minimum requirement.)
+- [minikube](https://minikube.sigs.k8s.io/docs/start/).
+
+2. Start minikube cluster
+```
+$ minikube start --vm-driver=docker --cpus 8 --memory 4096 --kubernetes-version v1.15.11
+```
+
+### Launch submarine in the cluster
+
+1. Clone the project
+```
+$ git clone https://github.com/apache/submarine.git
+```
+
+2. Install the resources by helm chart
+```
+$ cd submarine
+$ helm install submarine ./helm-charts/submarine
+```
+
Review comment:
In my opinion, it is necessary to tell users that how to connect to the Submarine workbench.
https://github.com/apache/submarine/blob/master/website/docs/gettingStarted/localDeployment.md#access-submarine-in-a-cluster
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] ByronHsu commented on pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
ByronHsu commented on pull request #664:
URL: https://github.com/apache/submarine/pull/664#issuecomment-878403017
@pingsutw @kevin85421 Need suggestions! Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] ByronHsu commented on pull request #664: SUBMARINE-928. [Quickstart] Rewrite quickstart guide
Posted by GitBox <gi...@apache.org>.
ByronHsu commented on pull request #664:
URL: https://github.com/apache/submarine/pull/664#issuecomment-878810166
TODO: 1. trim the memory limit 2. add mlflow demo
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@submarine.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org