Add design docs for protocol sharing #2141
Conversation
Add design docs for OpenPAI protocol sharing in marketplace.
Refine the design docs for protocol and marketplace, separate the implementation part and reserve minimum features.
| The protocol for a specific job can be written as a YAML file, which is called protocol file. A protocol file is valid if and only if it meets the schema in protocol. | ||
|
|
||
| To implement the protocol, we need to define the schema for job and validate a YAML file for the pre-defined schema. | ||
|
|
There was a problem hiding this comment.
To implement the protocol, we need to define the schema for job and validate a YAML file for the pre-defined schema.
define or extend? We have a base PAI protocol, right?
There was a problem hiding this comment.
Right. This part has been implemented and it refers to existing protocol.
docs/protocol/marketplace.md
Outdated
| ---------- | ||
|
|
||
| OpenPAI repository is a directory on file system, which contains other reposirory and __valid__ protocol files. | ||
| The structure of a repository can be defined by users, through component type, usage, or anything else. |
There was a problem hiding this comment.
what kind of "other repository" is supported?
There was a problem hiding this comment.
It's a recursive definition, "repository" is "OpenPAI repository".
| The root directory of a repository should contain a dot file or dot directory, which records configuration or information of the repository, and indicates that it is a repository. Possible configuration and information could be the repository's protocol files list (to track all files), components content index (to search content easily), information may be needed in the future like version and access details. | ||
|
|
||
| To implement the repository, we need to initialize the dot file or directory and update it everytime the repository is accessed. | ||
|
|
There was a problem hiding this comment.
Can we draw an architecture or component diagram to illustrate the relationship between protocol, job files, repositories and marketplace?
There was a problem hiding this comment.
I do have drawn a diagram in previous version. But to keep the design simple in the first stage and reserve minimum features to implement, removed it at present.
Refine marketplace design docs.
Add design docs for OpenPAI protocol sharing in marketplace.