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

Merge branch 'readme-markdown' into 'master'

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

See merge request !209
parents b4486899 ad104f5d
No related branches found
No related tags found
1 merge request!209meta [readme]: Switch the README.rst to markdown
Pipeline #74513 failed
include README.rst LICENSE
include README.md LICENSE
recursive-include doc *.py *.rst
recursive-include src/bob/bio/face/data *.pb
[![badge doc](https://img.shields.io/badge/docs-latest-orange.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/sphinx/index.html)
[![badge pipeline](https://gitlab.idiap.ch/bob/bob.bio.face/badges/master/pipeline.svg)](https://gitlab.idiap.ch/bob/bob.bio.face/commits/master)
[![badge coverage](https://gitlab.idiap.ch/bob/bob.bio.face/badges/master/coverage.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/coverage/)
[![badge gitlab](https://img.shields.io/badge/gitlab-project-0000c0.svg)](https://gitlab.idiap.ch/bob/bob.bio.face)
# Run face recognition algorithms
This package is part of the signal-processing and machine learning toolbox
[Bob](https://www.idiap.ch/software/bob).
This package is part of the `bob.bio` packages, which allow to run
comparable and reproducible biometric recognition experiments on publicly
available datasets.
This package contains functionality to run face recognition experiments.
It is an extension to the
[bob.bio.base](https://pypi.python.org/pypi/bob.bio.base) package, which
provides the basic scripts.
In this package, utilities that are specific for face recognition are
contained, such as:
* Image databases
* Image preprocesors, including face detection and facial image alignment
* Image feature extractors
* Recognition algorithms based on image features
## Installation
Complete Bob's
[installation instructions](https://www.idiap.ch/software/bob/install). Then,
to install this package, run:
``` sh
conda install bob.bio.face
```
## Contact
For questions or reporting issues to this software package, contact our
development [mailing list](https://www.idiap.ch/software/bob/discuss).
.. vim: set fileencoding=utf-8 :
.. Sat Aug 20 07:33:55 CEST 2016
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
:target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/sphinx/index.html
.. image:: https://gitlab.idiap.ch/bob/bob.bio.face/badges/master/pipeline.svg
:target: https://gitlab.idiap.ch/bob/bob.bio.face/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob.bio.face/badges/master/coverage.svg
:target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/coverage/
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
:target: https://gitlab.idiap.ch/bob/bob.bio.face
================================
Run face recognition algorithms
================================
This package is part of the signal-processing and machine learning toolbox
Bob_.
This package is part of the ``bob.bio`` packages, which allow to run comparable and reproducible biometric recognition experiments on publicly available databases.
This package contains functionality to run face recognition experiments.
It is an extension to the `bob.bio.base <http://pypi.python.org/pypi/bob.bio.base>`_ package, which provides the basic scripts.
In this package, utilities that are specific for face recognition are contained, such as:
* Image databases
* Image preprocesors, including face detection and facial image alignment
* Image feature extractors
* Recognition algorithms based on image features
Installation
------------
Complete Bob's `installation`_ instructions. Then, to install this package,
run::
$ conda install bob.bio.face
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
......@@ -73,7 +73,7 @@
package-dir = {"" = "src"}
[tool.setuptools.dynamic]
readme = {file = "README.rst"}
readme = {file = "README.md", content-type = "text/markdown"}
[project.entry-points."bob.bio.database"]
arface-all = "bob.bio.face.config.database.arface_all:database"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment