2019-03-25 01:22:43 +08:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2019-05-10 06:49:55 +08:00
< title > torchreid.utils.tools — torchreid 0.7.5 documentation< / title >
2019-03-25 01:22:43 +08:00
< script type = "text/javascript" src = "../../../_static/js/modernizr.min.js" > < / script >
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../../" src = "../../../_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "../../../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../../../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../../../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../../../_static/language_data.js" > < / script >
< script async = "async" type = "text/javascript" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< script type = "text/javascript" src = "../../../_static/js/theme.js" > < / script >
< link rel = "stylesheet" href = "../../../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../../_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "../../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../../search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../../index.html" class = "icon icon-home" > torchreid
< / a >
< div class = "version" >
2019-05-10 06:49:55 +08:00
0.7.5
2019-03-25 01:22:43 +08:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../user_guide.html" > How-to< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../datasets.html" > Datasets< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../evaluation.html" > Evaluation< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Package Reference< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/data.html" > torchreid.data< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/engine.html" > torchreid.engine< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/losses.html" > torchreid.losses< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/metrics.html" > torchreid.metrics< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/models.html" > torchreid.models< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/optim.html" > torchreid.optim< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../pkg/utils.html" > torchreid.utils< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Resources< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../AWESOME_REID.html" > Awesome-ReID< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../MODEL_ZOO.html" > Model Zoo< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../../index.html" > torchreid< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../../index.html" > Docs< / a > » < / li >
< li > < a href = "../../index.html" > Module code< / a > » < / li >
< li > torchreid.utils.tools< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 > Source code for torchreid.utils.tools< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "kn" > from< / span > < span class = "nn" > __future__< / span > < span class = "k" > import< / span > < span class = "n" > absolute_import< / span >
< span class = "kn" > from< / span > < span class = "nn" > __future__< / span > < span class = "k" > import< / span > < span class = "n" > print_function< / span >
< span class = "kn" > from< / span > < span class = "nn" > __future__< / span > < span class = "k" > import< / span > < span class = "n" > division< / span >
< span class = "n" > __all__< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' mkdir_if_missing' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' check_isfile' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' read_json' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' write_json' < / span > < span class = "p" > ,< / span >
< span class = "s1" > ' set_random_seed' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' download_url' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' read_image' < / span > < span class = "p" > ]< / span >
< span class = "kn" > import< / span > < span class = "nn" > sys< / span >
< span class = "kn" > import< / span > < span class = "nn" > os< / span >
< span class = "kn" > import< / span > < span class = "nn" > os.path< / span > < span class = "k" > as< / span > < span class = "nn" > osp< / span >
< span class = "kn" > import< / span > < span class = "nn" > time< / span >
< span class = "kn" > import< / span > < span class = "nn" > errno< / span >
< span class = "kn" > import< / span > < span class = "nn" > json< / span >
< span class = "kn" > from< / span > < span class = "nn" > collections< / span > < span class = "k" > import< / span > < span class = "n" > OrderedDict< / span >
< span class = "kn" > import< / span > < span class = "nn" > warnings< / span >
< span class = "kn" > import< / span > < span class = "nn" > random< / span >
< span class = "kn" > import< / span > < span class = "nn" > numpy< / span > < span class = "k" > as< / span > < span class = "nn" > np< / span >
< span class = "kn" > from< / span > < span class = "nn" > PIL< / span > < span class = "k" > import< / span > < span class = "n" > Image< / span >
< span class = "kn" > import< / span > < span class = "nn" > torch< / span >
< div class = "viewcode-block" id = "mkdir_if_missing" > < a class = "viewcode-back" href = "../../../pkg/utils.html#torchreid.utils.tools.mkdir_if_missing" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > mkdir_if_missing< / span > < span class = "p" > (< / span > < span class = "n" > dirname< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Creates dirname if it is missing." " " < / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > osp< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > (< / span > < span class = "n" > dirname< / span > < span class = "p" > ):< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > makedirs< / span > < span class = "p" > (< / span > < span class = "n" > dirname< / span > < span class = "p" > )< / span >
< span class = "k" > except< / span > < span class = "ne" > OSError< / span > < span class = "k" > as< / span > < span class = "n" > e< / span > < span class = "p" > :< / span >
< span class = "k" > if< / span > < span class = "n" > e< / span > < span class = "o" > .< / span > < span class = "n" > errno< / span > < span class = "o" > !=< / span > < span class = "n" > errno< / span > < span class = "o" > .< / span > < span class = "n" > EEXIST< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < / div >
< div class = "viewcode-block" id = "check_isfile" > < a class = "viewcode-back" href = "../../../pkg/utils.html#torchreid.utils.tools.check_isfile" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > check_isfile< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Checks if the given path is a file.< / span >
< span class = "sd" > Args:< / span >
< span class = "sd" > fpath (str): file path.< / span >
< span class = "sd" > Returns:< / span >
< span class = "sd" > bool< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > isfile< / span > < span class = "o" > =< / span > < span class = "n" > osp< / span > < span class = "o" > .< / span > < span class = "n" > isfile< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > isfile< / span > < span class = "p" > :< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "s1" > ' No file found at " < / span > < span class = "si" > {}< / span > < span class = "s1" > " ' < / span > < span class = "o" > .< / span > < span class = "n" > format< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > ))< / span >
< span class = "k" > return< / span > < span class = "n" > isfile< / span > < / div >
< div class = "viewcode-block" id = "read_json" > < a class = "viewcode-back" href = "../../../pkg/utils.html#torchreid.utils.tools.read_json" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > read_json< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Reads json file from a path." " " < / span >
< span class = "k" > with< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > ,< / span > < span class = "s1" > ' r' < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > f< / span > < span class = "p" > :< / span >
< span class = "n" > obj< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > load< / span > < span class = "p" > (< / span > < span class = "n" > f< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > obj< / span > < / div >
< div class = "viewcode-block" id = "write_json" > < a class = "viewcode-back" href = "../../../pkg/utils.html#torchreid.utils.tools.write_json" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > write_json< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "n" > fpath< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Writes to a json file." " " < / span >
< span class = "n" > mkdir_if_missing< / span > < span class = "p" > (< / span > < span class = "n" > osp< / span > < span class = "o" > .< / span > < span class = "n" > dirname< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > ))< / span >
< span class = "k" > with< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > fpath< / span > < span class = "p" > ,< / span > < span class = "s1" > ' w' < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > f< / span > < span class = "p" > :< / span >
< span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dump< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "n" > f< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 4< / span > < span class = "p" > ,< / span > < span class = "n" > separators< / span > < span class = "o" > =< / span > < span class = "p" > (< / span > < span class = "s1" > ' ,' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' : ' < / span > < span class = "p" > ))< / span > < / div >
< span class = "k" > def< / span > < span class = "nf" > set_random_seed< / span > < span class = "p" > (< / span > < span class = "n" > seed< / span > < span class = "p" > ):< / span >
< span class = "n" > random< / span > < span class = "o" > .< / span > < span class = "n" > seed< / span > < span class = "p" > (< / span > < span class = "n" > seed< / span > < span class = "p" > )< / span >
< span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > random< / span > < span class = "o" > .< / span > < span class = "n" > seed< / span > < span class = "p" > (< / span > < span class = "n" > seed< / span > < span class = "p" > )< / span >
< span class = "n" > torch< / span > < span class = "o" > .< / span > < span class = "n" > manual_seed< / span > < span class = "p" > (< / span > < span class = "n" > seed< / span > < span class = "p" > )< / span >
< span class = "n" > torch< / span > < span class = "o" > .< / span > < span class = "n" > cuda< / span > < span class = "o" > .< / span > < span class = "n" > manual_seed_all< / span > < span class = "p" > (< / span > < span class = "n" > seed< / span > < span class = "p" > )< / span >
< div class = "viewcode-block" id = "download_url" > < a class = "viewcode-back" href = "../../../pkg/utils.html#torchreid.utils.tools.download_url" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > download_url< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > dst< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Downloads file from a url to a destination.< / span >
< span class = "sd" > Args:< / span >
< span class = "sd" > url (str): url to download file.< / span >
< span class = "sd" > dst (str): destination path.< / span >
< span class = "sd" > " " " < / span >
< span class = "kn" > from< / span > < span class = "nn" > six.moves< / span > < span class = "k" > import< / span > < span class = "n" > urllib< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s1" > ' * url=" < / span > < span class = "si" > {}< / span > < span class = "s1" > " ' < / span > < span class = "o" > .< / span > < span class = "n" > format< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > ))< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s1" > ' * destination=" < / span > < span class = "si" > {}< / span > < span class = "s1" > " ' < / span > < span class = "o" > .< / span > < span class = "n" > format< / span > < span class = "p" > (< / span > < span class = "n" > dst< / span > < span class = "p" > ))< / span >
< span class = "k" > def< / span > < span class = "nf" > _reporthook< / span > < span class = "p" > (< / span > < span class = "n" > count< / span > < span class = "p" > ,< / span > < span class = "n" > block_size< / span > < span class = "p" > ,< / span > < span class = "n" > total_size< / span > < span class = "p" > ):< / span >
< span class = "k" > global< / span > < span class = "n" > start_time< / span >
< span class = "k" > if< / span > < span class = "n" > count< /span> < span class = "o" > ==< / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span >
< span class = "n" > start_time< / span > < span class = "o" > =< / span > < span class = "n" > time< / span > < span class = "o" > .< / span > < span class = "n" > time< / span > < span class = "p" > ()< / span >
< span class = "k" > return< / span >
< span class = "n" > duration< / span > < span class = "o" > =< / span > < span class = "n" > time< / span > < span class = "o" > .< / span > < span class = "n" > time< / span > < span class = "p" > ()< / span > < span class = "o" > -< / span > < span class = "n" > start_time< / span >
< span class = "n" > progress_size< / span > < span class = "o" > =< / span > < span class = "nb" > int< / span > < span class = "p" > (< / span > < span class = "n" > count< / span > < span class = "o" > *< / span > < span class = "n" > block_size< / span > < span class = "p" > )< / span >
< span class = "n" > speed< / span > < span class = "o" > =< / span > < span class = "nb" > int< / span > < span class = "p" > (< / span > < span class = "n" > progress_size< / span > < span class = "o" > /< / span > < span class = "p" > (< / span > < span class = "mi" > 1024< / span > < span class = "o" > *< / span > < span class = "n" > duration< / span > < span class = "p" > ))< / span >
< span class = "n" > percent< / span > < span class = "o" > =< / span > < span class = "nb" > int< / span > < span class = "p" > (< / span > < span class = "n" > count< / span > < span class = "o" > *< / span > < span class = "n" > block_size< / span > < span class = "o" > *< / span > < span class = "mi" > 100< / span > < span class = "o" > /< / span > < span class = "n" > total_size< / span > < span class = "p" > )< / span >
< span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "s1" > ' < / span > < span class = "se" > \r< / span > < span class = "s1" > ...< / span > < span class = "si" > %d%%< / span > < span class = "s1" > , < / span > < span class = "si" > %d< / span > < span class = "s1" > MB, < / span > < span class = "si" > %d< / span > < span class = "s1" > KB/s, < / span > < span class = "si" > %d< / span > < span class = "s1" > seconds passed' < / span > < span class = "o" > %< / span >
< span class = "p" > (< / span > < span class = "n" > percent< / span > < span class = "p" > ,< / span > < span class = "n" > progress_size< / span > < span class = "o" > /< / span > < span class = "p" > (< / span > < span class = "mi" > 1024< / span > < span class = "o" > *< / span > < span class = "mi" > 1024< / span > < span class = "p" > ),< / span > < span class = "n" > speed< / span > < span class = "p" > ,< / span > < span class = "n" > duration< / span > < span class = "p" > ))< / span >
< span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > flush< / span > < span class = "p" > ()< / span >
< span class = "n" > urllib< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "o" > .< / span > < span class = "n" > urlretrieve< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > dst< / span > < span class = "p" > ,< / span > < span class = "n" > _reporthook< / span > < span class = "p" > )< / span >
< span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "s1" > ' < / span > < span class = "se" > \n< / span > < span class = "s1" > ' < / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "read_image" > < a class = "viewcode-back" href = "../../../pkg/utils.html#torchreid.utils.tools.read_image" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > read_image< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Reads image from path using ``PIL.Image``.< / span >
< span class = "sd" > Args:< / span >
< span class = "sd" > path (str): path to an image.< / span >
< span class = "sd" > Returns:< / span >
< span class = "sd" > PIL image< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > got_img< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > osp< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "p" > ):< / span >
< span class = "k" > raise< / span > < span class = "ne" > IOError< / span > < span class = "p" > (< / span > < span class = "s1" > ' " < / span > < span class = "si" > {}< / span > < span class = "s1" > " does not exist' < / span > < span class = "o" > .< / span > < span class = "n" > format< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "p" > ))< / span >
< span class = "k" > while< / span > < span class = "ow" > not< / span > < span class = "n" > got_img< / span > < span class = "p" > :< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > img< / span > < span class = "o" > =< / span > < span class = "n" > Image< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > convert< / span > < span class = "p" > (< / span > < span class = "s1" > ' RGB' < / span > < span class = "p" > )< / span >
< span class = "n" > got_img< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
< span class = "k" > except< / span > < span class = "ne" > IOError< / span > < span class = "p" > :< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s1" > ' IOError incurred when reading " < / span > < span class = "si" > {}< / span > < span class = "s1" > " . Will redo. Don< / span > < span class = "se" > \' < / span > < span class = "s1" > t worry. Just chill.' < / span > < span class = "o" > .< / span > < span class = "n" > format< / span > < span class = "p" > (< / span > < span class = "n" > img_path< / span > < span class = "p" > ))< / span >
< span class = "k" > pass< / span >
< span class = "k" > return< / span > < span class = "n" > img< / span > < / div >
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2019, Kaiyang Zhou
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
