2017-09-11 Guide d'utilisation des notebooks et des scripts.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# How to use OptimalPrecision's notebooks and scripts\n",
    "\n",
    "## Notebooks .ipynb\n",
    "\n",
    "### \"xxx\" Notebooks\n",
    "  \n",
    "Les notebooks commençant par \"xxx\" sont les versions passées (parfois avec des erreurs) de certains notebooks, ainsi que des essais n'ayant pas abouti.  \n",
    "  \n",
    "xxx 2017-04-07 Bang-bang solution.ipynb  >>>  tout 1er modèle testé pour le bangbang  \n",
    "  \n",
    "xxx 2017-04-11 problem statement.ipynb  >>>  1ère réplication du modèle linéaire de Harris et Wolpert (comporte certainement des erreurs, et a été modifié dans un autre notebook)  \n",
    "  \n",
    "xxx 2017-05-02 Test.ipynb  >>>  notebook pour tester les paramètres du modèle linéaire de Harris et Wolpert (comporte certainement des erreurs, et a été modifié dans un autre notebook)  \n",
    "  \n",
    "xxx 2017-05-09 Bang-bang solution.ipynb  >>>  2ème modèle pour le bangbang comprenant une partie sur la poursuite  \n",
    "  \n",
    "xxx 2017-05-16 Minimization of the cost function in the gradient descent.ipynb  >>>  modèle linéaire H&W version 2 (version non définitive car comporte des erreurs)  \n",
    "  \n",
    "xxx 2017-06-01 Optimal trajectories by the minimum-variance theory.ipynb  >>>  modèle linéaire H&W version 3 (modèle correct mais paramètres non standards)  \n",
    "  \n",
    "xxx 2017-06-01 Minimum-variance theory and adaptation.ipynb  >>>  modèle linéaire H&W version 2 testé pour l'adaptation (aucun résultat ici, ce n'était pas concluant)  \n",
    "  \n",
    "xxx 2017-06-01 Minimum-variance theory and pursuit.ipynb  >>>  modèle linéaire H&W version 2 testé pour la poursuite (version non définitive car comporte des erreurs ; le modèle final traite les cas de fixation et de poursuite en même temps par le biais d'un seul paramètre : la vitesse de la cible)  \n",
    "  \n",
    "  \n",
    "  \n",
    "### Other notebooks\n",
    "\n",
    "Les autres notebooks sont soit des projets n'ayant pas entièrement abouti, soit, plus généralement, la version définitive des notebooks (notamment car le code a été grandement accéléré par la façon de l'écrire).  \n",
    "  \n",
    "2017-05-19 Tables of parameters.ipynb  >>>  ce notebook avait pour objectif de donner les valeurs optimales des paramètres de convergence suivant la valeur du pas de temps $dt$ utilisé dans le modèle de H&W, ainsi que des indicateurs sur la vitesse de convergence.  \n",
    "  \n",
    "2017-05-31 Automation of the learning process.ipynb  >>>  ce notebook est le notebook d'appel du script implémenté par le fichier HarrisWolpertandPursuit.py (ainsi que des fonctions pour les plots) ; il faut importer dans le notebook les fonctions présentes et utilisées dans le script, puis lancer un appel au notebook avec les paramètres que l'on veut (si le modèle a déjà été testé avec ces paramètres, la fonction va chercher les informations dans les pickle), ensuite on peut visionner les résultats. Le notebook fournit également une comparaison visuelle avec les modèles de bangbang  \n",
    "  \n",
    "2017-06-01 Bang-bang solution.ipynb  >>>  notebook définitif sur la solution bangbang symétrique, étendu à la poursuite  \n",
    "  \n",
    "2017-07-10 Asymmetrical bang-bang.ipynb  >>>  notebook non définitif car étendu à la poursuite via le notebook suivant  \n",
    "  \n",
    "2017-07-11 Asymmetrical bang-bang and pursuit.ipynb  >>>  notebook définitif sur la solution bangbang asymétrique, étendu à la poursuite  \n",
    "  \n",
    "2017-07-10 Saccadic correction.ipynb  >>>  modèle de correction saccadique fondé sur le modèle de H&W (à voir si utilisable pour l'adaptation saccadique)  \n",
    "  \n",
    "2017-06-13 Generalized coordinates.ipynb  >>>  modèle définitif de H&W étendu à la poursuite. Il permet le recours aux coordonnées généralisées (à voir quels sont les paramètres à modifier pour le cas strictement supérieur à deux coordonnées) ; il permet la poursuite de trajectoires non rectilignes (sinusoïdales par exemple) à condition que celles-ci soient des connaissances a priori (possible de rendre cela légitime par le biais d'un délai et d'une trajectoire cyclique : voir _Transitioning from Saccade to Smooth Pursuit Eye Movements using Linear Quadratic Tracking Control_ Korentis and Enderle, J Bioengineer & Biomedical Sci 2016, 6:3)  \n",
    "  \n",
    "2017-07-13 Noised trajectories.ipynb  >>>  analyse graphique de \"vraies\" trajectoires (bruitées) (moyenne théorique + moyenne empirique + intervalle de confiance) + possibilité de récupérer le Control Signal à partir de la position ou la vitesse dans le cadre du modèle de H&W\n",
    "  \n",
    "2017-07-26 Anticipatory SPEM .ipynb  >>>  étude de l'anticipation avant la poursuite d'un mobile. Le cadre de l'expérience : on fixe un point au centre de l'écran, après un délai de fixation, le point va à droite avec une probabilité $p$ et à gauche avec une probabilité $1-p$. Le sujet doit suivre le point et cela recommence. Plus $p$ est proche de 1, plus le sujet aura tendance à anticiper la trajectoire.  \n",
    "  \n",
    "  \n",
    "  \n",
    "## Script .py\n",
    "\n",
    "_xxx HarrisWolpert.py_ et _ControlInitFunction.py_ sont obsolètes.\n",
    "\n",
    "Les deux scripts utilisés sont :  \n",
    "  \n",
    "HarrisWolpertandPursuit.py  >>>  pour l'implémentation du modèle de H&W étendu à la poursuite, et comparé aux modèles de bangbang symétrique et asymétrique  \n",
    "  \n",
    "PlotFunctions.py  >>>  pour l'implémentation des fonctions de visualisation des résultats"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}