Skip to content

Commit 6d9bb54

Browse files
committed
Docs, retrigger test
1 parent 2a12fd8 commit 6d9bb54

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

ibllib/pipes/ephys_preprocessing.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -894,6 +894,16 @@ class EphysPostDLC(tasks.Task):
894894
}
895895

896896
def _run(self, overwrite=False, run_qc=True, plot_qc=True):
897+
"""
898+
Run the EphysPostDLC task. Returns a list of file locations for the output files in signature. The created plot
899+
(dlc_qc_plot.png) is not returned, but saved in session_path/snapshots and uploaded to Alyx as a note.
900+
901+
:param overwrite: bool, whether to recompute existing output files (default is False).
902+
Note that the dlc_qc_plot will be computed even if overwrite = False
903+
:param run_qc: bool, whether to run the DLC QC (default is True)
904+
:param plot_qc: book, whether to create the dlc_qc_plot (default is True)
905+
906+
"""
897907
# Check if output files exist locally
898908
exist, output_files = self.assert_expected(self.signature['output_files'], silent=True)
899909
if exist and not overwrite:

0 commit comments

Comments
 (0)