Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alibaba/pipcook

Machine learning platform for Web developers
https://github.com/alibaba/pipcook

js machine-learning pipeline tensorflow

Last synced: 3 days ago
JSON representation

Machine learning platform for Web developers

Awesome Lists containing this project

README 

        


  

    pipcook

  






  A JavaScript application framework for machine learning and its engineering.






  

    npm

  

    npm

  

    GitHub repo size

  

    






  Documentation: English | 中文




## Builds



| Build Types | Status |

|---------------|--------|

| tests         |  |

| documentation |  |

| docker        |  |



## Why Pipcook



With the mission of enabling JavaScript engineers to utilize the power of machine learning without any

prerequisites and the vision to lead front-end technical field to the intelligention. [Pipcook][] is to become

the JavaScript application framework for the cross-cutting area of machine learning and front-end interaction.



We are truly to design Pipcook's API for front-end and machine learning applications, and focusing on the front-end

area and developed from the JavaScript engineers' view. With the principle of being friendly to JavaScript, we will 

push the whole area forward with the machine learning engineering. For this reason we opened an issue about 

[machine-learning application APIs][], and look forward to you get involved.



## What's Pipcook



The project provides subprojects including machine learning pipeline framework, management tools, a JavaScript runtime for machine learning, and these can be also used as building blocks in conjunction with other projects.



### Principles



[Pipcook][] is an open-source project guided by strong principles, aiming to be modular and flexible on user experience. It is open to the community to help set its direction.



- **Modular** the project includes some of projects that have well-defined functions and APIs that work together.

- **Swappable** the project includes enough modules to build what Pipcook has done, but its modular architecture ensures that most of the modules can be swapped by different implementations.



### Audience



[Pipcook][] is intended for Web engineers looking to:



- learn what's machine learning.

- train their models and serve them.

- optimize own models for better model evaluation results, like higher accuracy for image classification.



> If you are in the above conditions, just try it via [installation guide](docs/INSTALL.md).



### Subprojects



__Pipcook Pipeline__



It's used to represent ML pipelines consisting of Pipcook scripts. This layer ensures the stability and scalability of the whole system and uses a plug-in mechanism to support rich functions including dataset, training, validations, and deployment.



A Pipcook Pipeline is generally composed of lots of scripts. Through different scripts and configurations, the final output to us is an NPM package, which contains the trained model and JavaScript functions that can be used directly.



> Note: In Pipcook, each pipeline has only one role, which is to output the above-trained model you need. That is to say, the last stage of each pipeline must be the output of the trained model, otherwise, this Pipeline is invalid.



__Pipcook Bridge to Python__



For JavaScript engineers, the most difficult part is the lack of a mature machine learning toolset in the ecosystem. In Pipcook, a module called [Boa][https://github.com/imgcook/boa], which provides access to Python packages by bridging the interface of [CPython][] using N-API.



With it, developers can use packages such as `numpy`, `scikit-learn`, `jieba`, `tensorflow`, or any other Python ecology in the Node.js runtime through JavaScript.



## Quick start



### Setup



Prepare the following on your machine:



| Installer   | Version Range |

|-------------|---------------|

| [Node.js][] | >= 12.17 or >= 14.0.0 |

| [npm][]    | >= 6.14.4       |



Install the command-line tool for managing [Pipcook][] projects:



```shell

$ npm install -g @pipcook/cli

```



Then train from anyone of those [pipelines](./example/pipelines/), we take image classification as an example:



```shell

$ pipcook train https://cdn.jsdelivr.net/gh/alibaba/pipcook@main/example/pipelines/image-classification-mobilenet.json -o ./output

```

This dataset specfied by the pipeline includes 2 categories image: avatar and blurBackground.

After training, we can predict the category of a image:



```shell

$ pipcook predict ./output/image-classification-mobilenet.json -s ./output/data/validation/blurBackground/71197_223__30.7_36.jpg

✔ Origin result:[{"id":1,"category":"blurBackground","score":0.9998120665550232}]

```



The input is a `blurBackground` image from the validation dataset. And the model determines that its category is `blurBackground`.



Want to deploy it?

```shell

$ pipcook serve ./output

ℹ preparing framework

ℹ preparing scripts

ℹ preparing artifact plugins

ℹ initializing framework packages

Pipcook has served at: http://localhost:9091

```



Then you can open the browser and try your image classification server.



### Playground



If you are wondering what you can do in [Pipcook][] and where you can check your training logs and models, you could start from [Pipboard](https://alibaba.github.io/pipcook/#/GLOSSORY?id=pipboard):



```sh

open https://pipboard.imgcook.com

```



You will see a web page prompt in your browser, and there is a MNIST showcase on the home page and play around there. 



### Pipelines



If you want to train a model to recognize MNIST handwritten digits by yourself, you could try the examples below.



| Name | Description | Open in Colab |

| ---- | ----------- | ----- |

| mnist-image-classification | pipeline for classific MNIST image classification problem. | N/A |

| databinding-image-classification | pipeline example to train the image classification task which is 
to classify [imgcook](https://www.imgcook.com/) databinding pictures. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/alibaba/pipcook/blob/main/notebooks/pipcook_image_classification.ipynb) |

| object-detection | pipeline example to train object detection task which is for component recognition 
used by imgcook. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/alibaba/pipcook/blob/main/notebooks/pipcook_object_detection.ipynb) |

| text-bayes-classification | pipeline example to train text classification task with bayes | N/A |



See [here](./example/pipelines) for complete list, and it's easy and quick to run these examples. For example, to do a MNIST 

image classification, just run the following to start the pipeline:



```sh

$ pipcook run https://cdn.jsdelivr.net/gh/alibaba/pipcook@main/example/pipelines/image-classification-mobilenet.json -o output

```



After the above pipeline is completed, you have already trained a model at the current `output/model` directory, it's a tensorflow.js model.



## Developers



Clone this repository:



```sh

$ git clone [email protected]:alibaba/pipcook.git

```



Install dependencies, e.g. via [npm][]:



```sh

$ npm install

```



After the above, now build the project:



```sh

$ npm run build

```



- Developer Documentation [English](./docs/contributing/guide-to-contributor.md) | [中文](./docs/zh-cn/contributing/guide-to-contributor.md)

- [Project Guide](./docs/meta/PROJECT_GUIDE.md)



## Community



#### DingTalk






Or searched via the group number: 30624012.



> Download DingTalk (an all-in-one free communication and collaboration platform) here: [English](https://www.dingtalk.com/static/en/download) | [中文](https://page.dingtalk.com/wow/dingtalk/act/download)



#### Gitter Room





  




#### Who's using it






## License



[Apache 2.0](./LICENSE)



[Pipcook]: https://github.com/alibaba/pipcook

[lerna]: https://github.com/lerna/lerna

[TypeScript]: https://github.com/microsoft/TypeScript

[Node.js]: https://nodejs.org/

[npm]: https://npmjs.com/

[Python]: https://www.python.org/

[CPython]: https://github.com/python/cpython

[machine-learning application APIs]: https://github.com/alibaba/pipcook/issues/33

[pipeline-mnist-image-classification]: example/pipelines/mnist-image-classification.json

[pipeline-databinding-image-classification]: example/pipelines/databinding-image-classification-mobilenet.json

[pipeline-object-detection]: example/pipelines/object-detection-yolo.json

[pipeline-text-bayes-classification]: example/pipelines/text-classification-bayes.json

[detectron2 installation reference]: https://github.com/facebookresearch/detectron2/blob/master/INSTALL.md