Skip to content
Snippets Groups Projects
Commit 5ed278d8 authored by Yannick DAYER's avatar Yannick DAYER
Browse files

meta [readme]: Switch the README.rst to markdown.

parent 03e04fb9
Branches
Tags
1 merge request!114meta [readme]: Switch the README.rst to markdown
Pipeline #73352 passed
include README.rst include LICENSE README.md
recursive-include doc *.rst *.png *.ico *.txt recursive-include doc *.rst *.png *.ico *.txt
recursive-include bob *.csv *.json *.pgm recursive-include bob *.csv *.json *.pgm
[![badge doc](https://img.shields.io/badge/docs-latest-orange.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/sphinx/index.html)
[![badge pipeline](https://gitlab.idiap.ch/bob/bob.pipelines/badges/master/pipeline.svg)](https://gitlab.idiap.ch/bob/bob.pipelines/commits/master)
[![badge coverage](https://gitlab.idiap.ch/bob/bob.pipelines/badges/master/coverage.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/coverage)
[![badge gitlab](https://img.shields.io/badge/gitlab-project-0000c0.svg)](https://gitlab.idiap.ch/bob/bob.pipelines)
# Tools to build robust and extensible pipelines
This package is part of the signal-processing and machine learning toolbox
[Bob](https://www.idiap.ch/software/bob).
The goal is to provide more flexible pipeline mechanisms for
[bob.bio.base](http://gitlab.idiap.ch/bob/bob.bio.base) and
[bob.pad.base](http://gitlab.idiap.ch/bob/bob.pad.base).
It is based on the
[scikit-learn pipeline](https://scikit-learn.org/stable/modules/compose.html)
and adds a layer to route data and metadata through the pipeline (which is not
supported by scikit-learn yet).
## Installation
Complete bob's
[installation instructions](https://www.idiap.ch/software/bob/install). Then,
to install this package, run:
``` sh
conda install bob.pipelines
```
## Contact
For questions or reporting issues to this software package, contact our
development [mailing list](https://www.idiap.ch/software/bob/discuss).
.. -*- coding: utf-8 -*-
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
:target: https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/sphinx/index.html
.. image:: https://gitlab.idiap.ch/bob/bob.pipelines/badges/master/pipeline.svg
:target: https://gitlab.idiap.ch/bob/bob.pipelines/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob.pipelines/badges/master/coverage.svg
:target: https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/coverage
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
:target: https://gitlab.idiap.ch/bob/bob.pipelines
===========================================================================
Tools to build robust and extensible pipelines
===========================================================================
This package is part of the signal-processing and machine learning toolbox Bob_.
This is **STILL EXPERIMENTAL** and the goal is to provide more flexible pipeline mechanism for `bob.bio.base <http://gitlab.idiap.ch/bob/bob.bio.base>`_ and `bob.pad.base <http://gitlab.idiap.ch/bob/bob.pad.base>`_.
Installation
------------
Complete bob's `installation`_ instructions. Then, to install this
package, run::
$ conda install bob.pipelines
Contact
-------
For questions or reporting issues to this software package, contact our
development `mailing list`_.
.. Place your references here:
.. _bob: https://www.idiap.ch/software/bob
.. _installation: https://www.idiap.ch/software/bob/install
.. _mailing list: https://www.idiap.ch/software/bob/discuss
...@@ -68,7 +68,7 @@ ...@@ -68,7 +68,7 @@
package-dir = {"" = "src"} package-dir = {"" = "src"}
[tool.setuptools.dynamic] [tool.setuptools.dynamic]
readme = {file = "README.rst"} readme = {file = "README.md", content-type = "text/markdown"}
[project.entry-points."dask.client"] [project.entry-points."dask.client"]
local-parallel = "bob.pipelines.config.distributed.local_parallel:dask_client" local-parallel = "bob.pipelines.config.distributed.local_parallel:dask_client"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment