swordfaith/openpaimarketplace

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.

Openpaimarketplace

---

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 [email protected] with any additional questions or comments.