Skip to content

Commit c027925

Browse files
Merge pull request #76 from LSSTDESC/documentation_fix
documentation fix
2 parents 7c56dc6 + 77c2dbf commit c027925

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs/learn_loop.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ In interactive mode, you must define the required variables and use the :py:mod:
8282
:linenos:
8383
8484
>>> from resspect.learn_loop import learn_loop
85+
>>> from resspect import LoopConfiguration
8586
8687
>>> nloops = 1000 # number of iterations
8788
>>> method = 'Bazin' # only option in v1.0
@@ -93,9 +94,9 @@ In interactive mode, you must define the required variables and use the :py:mod:
9394
>>> train = 'original' # initial training
9495
>>> batch = 1 # size of batch
9596
96-
>>> learn_loop(nloops=nloops, features_method=method, classifier=ml,
97+
>>> learn_loop(LoopConfiguration(nloops=nloops, features_method=method, classifier=ml,
9798
>>> strategy=strategy, path_to_features=input_file, output_metrics_file=metric,
98-
>>> output_queried_file=queried, training=train, batch=batch)
99+
>>> output_queried_file=queried, training=train, batch=batch))
99100
100101
Alternatively you can also run everything from the command line:
101102

docs/pre_processing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ For SNPCC using Bazin features:
250250
>>> features_file = 'results/Bazin.csv' # output file
251251
>>> feature_extractor = 'Bazin'
252252
253-
>>> fit_snpcc(path_to_data_dir=path_to_data_dir, features_file=features_file)
253+
>>> fit_snpcc(path_to_data_dir=path_to_data_dir, features_file=features_file, feature_extractor=feature_extractor)
254254
255255
For SNPCC using Malanchev features:
256256
^^^^^^^^^^
@@ -265,7 +265,7 @@ For SNPCC using Malanchev features:
265265
>>> features_file = 'results/Malanchev.csv' # output file
266266
>>> feature_extractor = 'Malanchev'
267267
268-
>>> fit_snpcc(path_to_data_dir=path_to_data_dir, features_file=features_file)
268+
>>> fit_snpcc(path_to_data_dir=path_to_data_dir, features_file=features_file, feature_extractor=feature_extractor)
269269
270270
271271
For PLAsTiCC:

0 commit comments

Comments
 (0)