Adding references and guidelines [skip ci]

raamana · Sep 7, 2017 · c4fc23b · c4fc23b
1 parent cb655ae
commit c4fc23b
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git 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
@@ -3,3 +3,5 @@ Metrics
 
 Definition of the different distances between the histograms are presented `here <http://pythonhosted.org//MedPy/metric.html#module-medpy.metric.histogram>`_.
 
+
+**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.**
diff --git 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
-Original file line number
+Diff line change
@@ Expand Up @@
        installation
        API
        usage
+       guidelines
        metrics
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,5 @@ Metrics

		Definition of the different distances between the histograms are presented `here <http://pythonhosted.org//MedPy/metric.html#module-medpy.metric.histogram>`_.


		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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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

Expand Down