diff --git a/docs/source/index.rst b/docs/source/index.rst index f51f1a3e6d9d6b39cfcd24ba1c5205978eef62fc..d4da5fc0bb1af40fc598cf727d0b1bbad1742c88 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,8 +6,12 @@ Welcome to MultiviewPlatform's documentation! ============================================= +This package is used as an easy-to-use platform to estimate different mono- and multi-view classifiers' performance on a multiview dataset. + +The main advantage of the platform is that it allows to add and remove a classifier without modifying its core code (the procedure is described thoroughly in this documentation). + .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :caption: Contents: api diff --git a/docs/source/monomulti/monoview_classifier.ipynb b/docs/source/monomulti/monoview_classifier.ipynb new file mode 100644 index 0000000000000000000000000000000000000000..99e590d32dabaa22cdf05f1713e27238209296f3 --- /dev/null +++ b/docs/source/monomulti/monoview_classifier.ipynb @@ -0,0 +1,100 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Monoview classifier framework" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## File addition" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "* In the `MonoviewClassifiers` package, you need to add a python module called after your monoview classifier (let's call it MOC for **MO**noview **C**lassifier)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## The `MOC.py` file" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "In this file, you need to add several functions forthe platform to be able to use your classifier, they are alllisted below : " + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### `canProbas`" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "This function is just used to knowif the classifier can predict a probability for each label instead of just predicting the a label." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "collapsed": true + }, + "outputs": [], + "source": [ + "def canProbas():\n", + " return True" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### `fit`" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "This function returns a fitted sklearn classifier object" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 2", + "language": "python", + "name": "python2" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 2.0 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython2", + "version": "2.7.13" + } + }, + "nbformat": 4, + "nbformat_minor": 0 +} \ No newline at end of file diff --git a/docs/source/monomultidoc.rst b/docs/source/monomultidoc.rst index 183b75b0b00e299a19ef011f141ed1cd3b57e859..12b23c9b43fd3ed18e69dbd6a6fd4b86065b4575 100644 --- a/docs/source/monomultidoc.rst +++ b/docs/source/monomultidoc.rst @@ -6,6 +6,7 @@ Mono and mutliview classification :caption: Contents: monomulti/metrics + monomulti/monoview_classifier + monomulti/multiview_classifier monomulti/exec_classif monomulti/result_analysis - monomulti/multiview_classifier \ No newline at end of file