Comments (3)
How about this change: “How to use pipcook” > "How to use pipeline"?
from pipcook.
Currently the developer guide is not clear enough, it should include:
We need to make our developers map be clear as:
- Pipeline Developer(user)
- Plugin Developer
- Contributor
And in our original "Developer Guide", it means the documentation for the last contributor, it's a good start to refine our documentation TOC at this issue, too. The following is mine:
- Get Started
- (MLApp)
- Pipeline
- Plugin
- Contribution Guide
from pipcook.
There is no doc / api reference for plugins themselves, so that the users are not clear what plugins we have and what parameters should be includes for specific plugin. We need to optimize plugin doc.
IMO we should split this into separate issues to address:
users are not clear what plugins we have.
It's good to maintain the plugins list so that user can browser there.
users are not clear what parameters should be included for specific plugin
To address this problem, that's @utkobe proposed improve the plugin API documentation. Moreover, because we are using TypeScript to write plugins, so we are absolutely able to provide more structured tools for better pipeline writings, for example:
- a tool to help generating plugin docs(https://github.com/rust-lang/docs.rs).
- hosted documentation of the maintained plugins at our project documentation.
- vscode plugin that makes suggestion for plugin parameters when writing the Pipeline.
from pipcook.
Related Issues (20)
- data in doc can not download HOT 1
- support deno HOT 1
- npm run 运行失败 HOT 1
- 目前pipline中目标检测模型脚本中 不支持传入预训练模型做参数
- 按照官方文档执行报错403 HOT 9
- 群二维码过期了 HOT 1
- The specified module could not be found HOT 1
- run pipeline error: Forbidden HOT 12
- 求一种可以离线运行脚本的方式 HOT 1
- i use object-detection on colab, when i predict, Origin result:[[]]
- boa init error HOT 1
- boa init error in centos8 HOT 1
- FaaS平台下执行boa失败 HOT 2
- Error: Boa install fails when npm installing in a folder name that contains a space HOT 4
- 数据集无法下载 HOT 1
- 我安装完之后没有什么反应,运行命令也没 HOT 1
- run pipeline error: Forbidden
- run pipeline error: Forbidden sudo pipcook train http://172.22.133.15:8000/image-classification-mobilenet.json
- 安装成功之后不管任何运行命令(比如 pipcook --help)都会打开 nodeJs 下的 pipcook.js 文件,然后程序就停止运行了
- 安装完成后无任何反应
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pipcook.