From c4fc23b837f072888f5a359ac4df0e1c38ba5d8e Mon Sep 17 00:00:00 2001 From: Pradeep Reddy Raamana Date: Thu, 7 Sep 2017 09:24:02 -0400 Subject: [PATCH] Adding references and guidelines [skip ci] --- docs/index.rst | 1 + docs/metrics.rst | 2 ++ docs/usage.rst | 2 ++ 3 files changed, 5 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index f6d8f9e..a18ba4c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,6 +30,7 @@ Hiwenet helps you extracts histogram-distance weighted networks for feature extr installation API usage + guidelines metrics diff --git a/docs/metrics.rst b/docs/metrics.rst index 80adf40..fb8bfb5 100644 --- a/docs/metrics.rst +++ b/docs/metrics.rst @@ -3,3 +3,5 @@ Metrics Definition of the different distances between the histograms are presented `here `_. + +**I plan to add more families of distances and metrics soon, your comments on what could be good additions will be appreciated, or links to similar repositories that I can link to will be appreciated.** \ No newline at end of file diff --git a/docs/usage.rst b/docs/usage.rst index 0a3f936..156e428 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -7,6 +7,8 @@ Them proceed to your typical subsequent analysis (such as classification etc). A rough example of usage can be: +.. TODO add examples to show how hiwenet can be used in place of ConnectomeMeasure of nilearn, or other uses in MNE. + .. code-block:: python