Documentation changes in bob bio annotate
4 unresolved threads
4 unresolved threads
Depends on bob.extension!86 (merged)
Merge request reports
Activity
@tiago.pereira @andre.anjos @theophile.gentilhomme if you have some click command implemented, it's a good idea to make it look like this one.
Edited by Amir MOHAMMADI7 7 from bob.extension.scripts.click_helper import ( 8 verbosity_option, ConfigCommand, ResourceOption) 8 verbosity_option, ConfigCommand, ResourceOption, log_parameters) 9 9 from bob.io.base import create_directories_safe 10 10 from bob.bio.base.tools.grid import indices 11 11 12 12 logger = logging.getLogger(__name__) 13 13 14 14 15 @click.command(entry_point_group='bob.bio.config', cls=ConfigCommand) 15 ANNOTATE_EPILOG = '''\b 16 Examples: 17 18 $ bob bio annotate -vvv -d <database> -a <annotator> -o /tmp/annotations 19 $ jman submit --array 64 -- bob bio annotate ... --array 64 20 ''' 30 help='A callable that takes the database and a sample (biofile) ' 31 'of the database and returns the annotations in a dictionary.') 32 @click.option('--output-dir', '-o', required=True, cls=ResourceOption, 33 help='The directory to save the annotations.') 34 @click.option('--force', '-f', is_flag=True, cls=ResourceOption, 35 help='Whether to overwrite existing annotations.') 36 @click.option('--array', type=click.INT, default=1, cls=ResourceOption, 37 help='Use this option alongside gridtk to submit this script as ' 38 'an array job.') 23 39 @click.option('--database-directories-file', cls=ResourceOption, 24 default=expanduser('~/.bob_bio_databases.txt')) 40 default=expanduser('~/.bob_bio_databases.txt'), 41 help='(Deprecated) To support loading of old databases.') 25 42 @verbosity_option(cls=ResourceOption) 26 43 def annotate(database, annotator, output_dir, force, array, 27 44 database_directories_file, **kwargs): 14 14 15 @click.command(entry_point_group='bob.bio.config', cls=ConfigCommand) 15 ANNOTATE_EPILOG = '''\b 16 Examples: 17 18 $ bob bio annotate -vvv -d <database> -a <annotator> -o /tmp/annotations 19 $ jman submit --array 64 -- bob bio annotate ... --array 64 20 ''' 21 22 23 @click.command(entry_point_group='bob.bio.config', cls=ConfigCommand, 24 epilog=ANNOTATE_EPILOG) 16 25 @click.option('--database', '-d', required=True, cls=ResourceOption, 17 entry_point_group='bob.bio.database') 26 entry_point_group='bob.bio.database', 27 help='''The database that you want to annotate.''') added 1 commit
- e0cd8165 - Fix broken click commands cref bob.extension!86 (merged)
enabled an automatic merge when the pipeline for e0cd8165 succeeds
added 1 commit
- 792c7b8a - Fix broken click commands cref bob.extension!86 (merged)
enabled an automatic merge when the pipeline for 792c7b8a succeeds
mentioned in issue #126 (closed)
mentioned in commit b404f0d5
Please register or sign in to reply