Merge pull request #42 from SpikeInterface/fix_typo

compute_performence -> compute_performance

.travis.yml

@@ -6,8 +6,8 @@ python:
 - '3.6'
 install:
 - pip install https://github.com/SpikeInterface/spikeextractors/archive/master.zip
-- pip install https://github.com/SpikeInterface/spikesorters/archive/master.zip
 - pip install https://github.com/SpikeInterface/spiketoolkit/archive/master.zip
+- pip install https://github.com/SpikeInterface/spikesorters/archive/master.zip
 - pip install .
 - pip install pytest==4.3
 - pip install matplotlib==3.2.2

spikecomparison/__init__.py

@@ -2,7 +2,7 @@
 
 from .comparisontools import (count_matching_events, compute_agreement_score, count_match_spikes,
         make_agreement_scores, make_possible_match, make_best_match, make_hungarian_match, 
-        do_score_labels, compare_spike_trains, do_confusion_matrix, do_count_score, compute_performence)
+        do_score_labels, compare_spike_trains, do_confusion_matrix, do_count_score, compute_performance)
 from .symmetricsortingcomparison import compare_two_sorters, SymmetricSortingComparison
 from .groundtruthcomparison import compare_sorter_to_ground_truth, GroundTruthComparison
 from .multisortingcomparison import compare_multiple_sorters, MultiSortingComparison

spikecomparison/collisioncomparison.py

@@ -3,7 +3,7 @@
 from .groundtruthcomparison import GroundTruthComparison
 #~ from .comparisontools import (do_score_labels, make_possible_match,
                               #~ make_best_match, make_hungarian_match, do_confusion_matrix, do_count_score,
-                              #~ compute_performence)
+                              #~ compute_performance)
 from .comparisontools import make_collision_events
 
 

spikecomparison/comparisontools.py

@@ -608,9 +608,9 @@ def do_count_score(event_counts1, event_counts2, match_12, match_event_count):
 _perf_keys = ['accuracy', 'recall', 'precision', 'false_discovery_rate', 'miss_rate']
 
 
-def compute_performence(count_score):
+def compute_performance(count_score):
     """
-    This compte perf formula.
+    This compute perf formula.
     this trick here is that it works both on pd.Series and pd.Dataframe
     line by line.
     This it is internally used by perf by psiketrain and poll_with_sum.

spikecomparison/groundtruthcomparison.py

@@ -3,7 +3,7 @@
 from .basecomparison import BaseTwoSorterComparison
 from .comparisontools import (do_score_labels, make_possible_match,
                               make_best_match, make_hungarian_match, do_confusion_matrix, do_count_score,
-                              compute_performence)
+                              compute_performance)
 
 
 class GroundTruthComparison(BaseTwoSorterComparison):
@@ -165,7 +165,7 @@ def get_performance(self, method='by_unit', output='pandas'):
             perf = self.count_score
 
         elif method == 'by_unit':
-            perf = compute_performence(self.count_score)
+            perf = compute_performance(self.count_score)
 
         elif method == 'pooled_with_average':
             perf = self.get_performance(method='by_unit').mean(axis=0)

spikecomparison/tests/test_comparisontools.py

@@ -4,7 +4,7 @@
 from spikecomparison.comparisontools import (do_count_event, make_match_count_matrix, make_agreement_scores,
                                              make_possible_match, make_best_match, make_hungarian_match,
                                              do_score_labels, compare_spike_trains, do_confusion_matrix, do_count_score,
-                                             compute_performence)
+                                             compute_performance)
 
 
 def make_sorting(times1, labels1, times2, labels2):
@@ -206,7 +206,7 @@ def test_do_count_score_and_perf():
     assert count_score.at[0, 'tested_id'] == 0
     assert count_score.at[1, 'tested_id'] == 5
 
-    perf = compute_performence(count_score)
+    perf = compute_performance(count_score)
     #  print(perf)
 
     assert perf.at[0, 'accuracy'] == 2 / 3