Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
Refine homepage for new users (#2155)
Browse files Browse the repository at this point in the history
Updated first level bullets, to add more content for administrators and users, who is first time touch OpenPAI, or computing platform.
  • Loading branch information
squirrelsc authored Mar 1, 2019
1 parent 953d655 commit 4294699
Show file tree
Hide file tree
Showing 9 changed files with 174 additions and 83 deletions.
185 changes: 127 additions & 58 deletions README.md

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions contrib/pai_vscode/VSCodeExt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# OpenPAI VS Code Client

## Installation

Visual Studio Code is a free, lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. Go to [Visual Studio Code Official Site](https://code.visualstudio.com/) to install and learn more.

OpenPAI Client is a VS Code extension to connect PAI clusters, submit AI jobs, and manage files on HDFS, etc. You need to install the extension in VS code before using it.

To install the OpenPAI Client:

1. Launch VS Code.
2. Click the "Extensions" icon in Activity Bar or press **Ctrl+Shift+X** to bring up the Extensions view.
3. Input **openpai** in the text box, the OpenPAI VS Code Client will appear in the result list.
4. Click the **Install** button. The extension will be installed.
5. After a successful installation, you will see an introduction page. Follow the instructions there and try the PAI client.

![Extension](./assets/ext-install-1.png)

## Next step

Learn how to [use OpenPAI VS Code Client](./README.md)
Binary file added contrib/pai_vscode/assets/ext-install-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion deployment/clusterObjectModel/mainParser/machine.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def validation_default_machine_properties(self):
def validation_machine_sku(self):
cluster_cfg = self.cluster_configuration
if "machine-sku" not in cluster_cfg:
return False, "mahince-sku is miss."
return False, "machine-sku is miss."
for sku_name in cluster_cfg["machine-sku"]:
sku = cluster_cfg["machine-sku"][sku_name]
if "cpu" not in sku:
Expand Down
Binary file removed docs/images/PAI_ask_question1.PNG
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/pai-management/doc/how-to-bootup-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

#### Prerequires

Before deploying kubernete with OpenPAI, please be sure that your hardware and os meet the requirement in the [link](../../../README.md#ref_prerequisites)
Before deploying kubernete with OpenPAI, please be sure that your hardware and os meet the requirement in the [link](../../../README.md#prerequisites)


#### Command
Expand Down
3 changes: 2 additions & 1 deletion docs/pai-management/doc/how-to-generate-cluster-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@ The `paictl` tool sets the following default values in the 4 configuration files
| ```REST server's admin user``` | REST server's admin user is set to `admin`, and its password is set to `admin-password` |
| ```VC``` | There is only one VC in the system, `default`, which has 100% of the resource capacity. |

### Optional Step 3. Customize configure OpenPAI <a name="Customize"></a>
<a name="Customize"></a>
### Optional Step 3. Customize configure OpenPAI
This method is for advanced users.

The description of each field in these configuration files can be found in [A Guide For Cluster Configuration](./customized-configuration.md).
Expand Down
38 changes: 20 additions & 18 deletions docs/stackoverflow.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
## How to ask a question on Stack Overflow about OpenPAI
# Search or ask questions on Stack Overflow about OpenPAI

### 1. Click the "Ask Question" button.
Navigate to the Stack Overflow homepage in your browser at stackoverflow.com. In the upper right hand corner of the page, you should see the Ask Question button, which you should click to continue.
## Search existing questions

![PAI_ask_question1](./images/PAI_ask_question1.PNG)
We recommend searching before asking. In case someone met the similar problem, it may save your time. [click here](https://stackoverflow.com/questions/tagged/openpai) to find related questions.

### 2. Read the disclaimer.
Then check the box box indicating you have read and understand the disclaimer and click "Proceed." Now you're ready to ask your question!
## Ask a question about OpenPAI

![PAI_ask_question2](./images/PAI_ask_question2.PNG)
1. Click [the link](https://stackoverflow.com/questions/ask?tags=openpai) with 'openpai' tag.

### 3. Fill in the necessary information.
This is where your problem description and title come in handy. Fill in the information and take a moment to double check spelling and grammar. That last thing you want is someone hassling your usage instead of answering your question. Then click on "Post your question."
You need to sign up at first use. Go ahead, Stack Overflow is a trustworthy web site. Or you can ask question on [github](https://github.com/Microsoft/pai/issues/new/choose) directly.

![PAI_ask_question3](./images/PAI_ask_question3.PNG)
1. Read the advice and proceed.

### 4. Add any relevant tags.
In the tags field, when you begin typing, the Stack Overflow system will automatically suggest likely tags to help you with this process. Be sure you read the descriptions for your tags. An incorrect tag can seriously limit potential responses.
You can read advice or search related topic again. If you still want to post a new question, choose the checkbox below, and click 'proceed'.

![PAI_ask_question4](./images/PAI_ask_question4.PNG)
![PAI_ask_question2](./images/PAI_ask_question2.PNG)

1. Ask the question, then click on "Post Your question"

## How to search OpenPAI related questions
OpenPAI's stackoverflow tag: openpai. User could view questions and ask questions under this tag.
- [StackOverflow: tag openpai](https://stackoverflow.com/questions/tagged/openpai)
![PAI_ask_question3](./images/PAI_ask_question3.PNG)

1. Add any relevant tags.

In the tags field, when you begin typing, the Stack Overflow system will automatically suggest likely tags to help you with this process. We already choose 'opanpai' tag for you.

![PAI_ask_question4](./images/PAI_ask_question4.PNG)

Referenece:
- https://stackoverflow.com/help/how-to-ask
- https://www.wikihow.com/Ask-a-Question-on-Stack-Overflow

* [How do I ask a good question?](https://stackoverflow.com/help/how-to-ask)
* [How to Ask a Question on Stack Overflow](https://www.wikihow.com/Ask-a-Question-on-Stack-Overflow)
6 changes: 2 additions & 4 deletions docs/system_architecture.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
## System Architecture

<p style="text-align: left;">
<img src="https://github.com/Microsoft/pai/blob/master/sysarch.png" title="System Architecture" alt="System Architecture" />
</p>
![System Architecture](../sysarch.png)

The system architecture is illustrated above.
User submits jobs or monitors cluster status through the [Web Portal](webportal/README.md),
Expand All @@ -15,4 +13,4 @@ The job, scheduled by YARN with [GPU enhancement](https://issues.apache.org/jira
can leverage GPUs in the cluster for deep learning computation. Other type of CPU based AI workloads or traditional big data job
can also run in the platform, coexisted with those GPU-based jobs.
The platform leverages HDFS to store data. All jobs are assumed to support HDFS.
All the static services (blue-lined box) are managed by Kubernetes, while jobs (purple-lined box) are managed by Hadoop YARN.
All the static services (blue-lined box) are managed by Kubernetes, while jobs (purple-lined box) are managed by Hadoop YARN.

0 comments on commit 4294699

Please sign in to comment.