Coder Social home page Coder Social logo

Comments (3)

yorkie avatar yorkie commented on May 8, 2024

How about this change: “How to use pipcook” > "How to use pipeline"?

from pipcook.

yorkie avatar yorkie commented on May 8, 2024

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.

yorkie avatar yorkie commented on May 8, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.