A marketplace which stores examples and job templates of openpai. Users could use openpaimarketplace to share their jobs or run-and-learn others' sharing job.
Перейти к файлу
dependabot[bot] d907dc2183
Bump url-parse from 1.5.1 to 1.5.3 in /webportal (#328)
2021-08-13 07:33:21 +00:00
.github Add code owners (#299) 2021-05-26 13:24:33 +08:00
design Update template 2020-07-10 13:29:23 +08:00
docs Update text (#302) 2021-05-26 14:41:43 +08:00
examples Update tags and categories of the examples (#319) 2021-06-24 13:35:38 +08:00
publish fix sku mismatch in distributed job templates (#78) 2020-10-30 14:19:06 +08:00
rest_server Bump path-parse from 1.0.6 to 1.0.7 in /rest_server (#327) 2021-08-13 07:30:14 +00:00
tools Fix workflow (#39) 2020-08-04 16:52:22 +08:00
webportal Bump url-parse from 1.5.1 to 1.5.3 in /webportal (#328) 2021-08-13 07:33:21 +00:00
.editorconfig Add eslint to rest server 2020-03-26 15:57:02 +08:00
.gitignore Refactor example files structure (#92) 2020-11-17 10:54:54 +08:00
.readthedocs.yml Create readthedocs config file (#137) 2020-11-30 14:03:02 +08:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2019-12-29 20:19:03 -08:00
LICENSE Initial LICENSE commit 2019-12-29 20:19:04 -08:00
README.md Update openpai -> OpenPAI (#301) 2021-05-26 13:39:05 +08:00
RELEASE_NOTE.md Add release note of v1.7.0 (#283) 2021-04-22 15:01:38 +08:00
SECURITY.md Update version to v2.0.0 (#53) 2020-08-31 17:42:17 +08:00
index.html Utilize job protocol in market item (#49) 2020-08-26 14:50:19 +08:00
mkdocs.yml update release note and readthedocs (#250) 2021-03-10 16:44:43 +08:00

README.md

Marketplace Logo

Openpaimarketplace

Publish Docker Image Webportal CI Rest Server CI Doc Release


A marketplace which stores data and job templates of OpenPAI. Users could use openpaimarketplace to share their jobs or run-and-learn others' sharing job.

Components

There are two components of openpaimarketplace, rest server and webportal, which are responsible for backend service and frontend UI seperately.

Getting Started

  • For Admin

    To the admin user who is responsible for deploying and managing OpenPAI and openpaimarketplace, please check admin manual for help.

  • For User

    To the normal user who wants to use marketplace templates in OpenPAI, please check user manual for help.

Reference

  • OpenPAI: A complete solution for AI platform. HiveD will be more user-friendly when working in tandem with OpenPAI.

  • OpenPAI Protocol: The protocol interface between marketplace and OpenPAI platform.

Developing Guide

This section is a guide for developers who are new to openpaimarketplace. Openpaimarketplace contains 2 sub projects, rest_server and webportal. For the detailed developing guide, you should refer to the readme doc of each sub project.

rest_server

Rest server uses nodejs as backend service framework. The api follows RESTful API specification.

webportal

Currently openpaimarketplace webportal is used as a pai webportal plugin. It uses react as frontend framework, and builds with webpack bundler.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.