download.py 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. ## @package download
  2. # Module caffe2.python.models.download
  3. import argparse
  4. import os
  5. import sys
  6. import signal
  7. import re
  8. import json
  9. from caffe2.proto import caffe2_pb2
  10. # Import urllib
  11. from urllib.error import HTTPError, URLError
  12. import urllib.request as urllib
  13. # urllib requires more work to deal with a redirect, so not using vanity url
  14. DOWNLOAD_BASE_URL = "https://s3.amazonaws.com/download.caffe2.ai/models/"
  15. DOWNLOAD_COLUMNS = 70
  16. # Don't let urllib hang up on big downloads
  17. def signalHandler(signal, frame):
  18. print("Killing download...")
  19. exit(0)
  20. signal.signal(signal.SIGINT, signalHandler)
  21. def deleteDirectory(top_dir):
  22. for root, dirs, files in os.walk(top_dir, topdown=False):
  23. for name in files:
  24. os.remove(os.path.join(root, name))
  25. for name in dirs:
  26. os.rmdir(os.path.join(root, name))
  27. os.rmdir(top_dir)
  28. def progressBar(percentage):
  29. full = int(DOWNLOAD_COLUMNS * percentage / 100)
  30. bar = full * "#" + (DOWNLOAD_COLUMNS - full) * " "
  31. sys.stdout.write(u"\u001b[1000D[" + bar + "] " + str(percentage) + "%")
  32. sys.stdout.flush()
  33. def downloadFromURLToFile(url, filename, show_progress=True):
  34. try:
  35. print("Downloading from {url}".format(url=url))
  36. response = urllib.urlopen(url)
  37. size = int(response.info().get('Content-Length').strip())
  38. chunk = min(size, 8192)
  39. print("Writing to {filename}".format(filename=filename))
  40. if show_progress:
  41. downloaded_size = 0
  42. progressBar(0)
  43. with open(filename, "wb") as local_file:
  44. while True:
  45. data_chunk = response.read(chunk)
  46. if not data_chunk:
  47. break
  48. local_file.write(data_chunk)
  49. if show_progress:
  50. downloaded_size += len(data_chunk)
  51. progressBar(int(100 * downloaded_size / size))
  52. print("") # New line to fix for progress bar
  53. except HTTPError as e:
  54. raise Exception("Could not download model. [HTTP Error] {code}: {reason}."
  55. .format(code=e.code, reason=e.reason))
  56. except URLError as e:
  57. raise Exception("Could not download model. [URL Error] {reason}."
  58. .format(reason=e.reason))
  59. def getURLFromName(name, filename):
  60. return "{base_url}{name}/{filename}".format(base_url=DOWNLOAD_BASE_URL,
  61. name=name, filename=filename)
  62. def downloadModel(model, args):
  63. # Figure out where to store the model
  64. model_folder = '{folder}'.format(folder=model)
  65. dir_path = os.path.dirname(os.path.realpath(__file__))
  66. if args.install:
  67. model_folder = '{dir_path}/{folder}'.format(dir_path=dir_path,
  68. folder=model)
  69. # Check if that folder is already there
  70. if os.path.exists(model_folder) and not os.path.isdir(model_folder):
  71. if not args.force:
  72. raise Exception("Cannot create folder for storing the model,\
  73. there exists a file of the same name.")
  74. else:
  75. print("Overwriting existing file! ({filename})"
  76. .format(filename=model_folder))
  77. os.remove(model_folder)
  78. if os.path.isdir(model_folder):
  79. if not args.force:
  80. response = ""
  81. query = "Model already exists, continue? [y/N] "
  82. try:
  83. response = raw_input(query)
  84. except NameError:
  85. response = input(query)
  86. if response.upper() == 'N' or not response:
  87. print("Cancelling download...")
  88. exit(0)
  89. print("Overwriting existing folder! ({filename})".format(filename=model_folder))
  90. deleteDirectory(model_folder)
  91. # Now we can safely create the folder and download the model
  92. os.makedirs(model_folder)
  93. for f in ['predict_net.pb', 'init_net.pb']:
  94. try:
  95. downloadFromURLToFile(getURLFromName(model, f),
  96. '{folder}/{f}'.format(folder=model_folder,
  97. f=f))
  98. except Exception as e:
  99. print("Abort: {reason}".format(reason=str(e)))
  100. print("Cleaning up...")
  101. deleteDirectory(model_folder)
  102. exit(0)
  103. if args.install:
  104. os.symlink("{folder}/__sym_init__.py".format(folder=dir_path),
  105. "{folder}/__init__.py".format(folder=model_folder))
  106. def validModelName(name):
  107. invalid_names = ['__init__']
  108. if name in invalid_names:
  109. return False
  110. if not re.match("^[/0-9a-zA-Z_-]+$", name):
  111. return False
  112. return True
  113. class ModelDownloader:
  114. def __init__(self, model_env_name='CAFFE2_MODELS'):
  115. self.model_env_name = model_env_name
  116. def _model_dir(self, model):
  117. caffe2_home = os.path.expanduser(os.getenv('CAFFE2_HOME', '~/.caffe2'))
  118. models_dir = os.getenv(self.model_env_name, os.path.join(caffe2_home, 'models'))
  119. return os.path.join(models_dir, model)
  120. def _download(self, model):
  121. model_dir = self._model_dir(model)
  122. assert not os.path.exists(model_dir)
  123. os.makedirs(model_dir)
  124. for f in ['predict_net.pb', 'init_net.pb', 'value_info.json']:
  125. url = getURLFromName(model, f)
  126. dest = os.path.join(model_dir, f)
  127. try:
  128. downloadFromURLToFile(url, dest, show_progress=False)
  129. except TypeError:
  130. # show_progress not supported prior to
  131. # Caffe2 78c014e752a374d905ecfb465d44fa16e02a28f1
  132. # (Sep 17, 2017)
  133. downloadFromURLToFile(url, dest)
  134. except Exception:
  135. deleteDirectory(model_dir)
  136. raise
  137. # This version returns an extra debug_str argument that helps to understand
  138. # why our work sometimes fails in sandcastle
  139. def get_c2_model_dbg(self, model_name):
  140. debug_str = "get_c2_model debug:\n"
  141. model_dir = self._model_dir(model_name)
  142. if not os.path.exists(model_dir):
  143. self._download(model_name)
  144. c2_predict_pb = os.path.join(model_dir, 'predict_net.pb')
  145. debug_str += "c2_predict_pb path: " + c2_predict_pb + "\n"
  146. c2_predict_net = caffe2_pb2.NetDef()
  147. with open(c2_predict_pb, 'rb') as f:
  148. len_read = c2_predict_net.ParseFromString(f.read())
  149. debug_str += "c2_predict_pb ParseFromString = " + str(len_read) + "\n"
  150. c2_predict_net.name = model_name
  151. c2_init_pb = os.path.join(model_dir, 'init_net.pb')
  152. debug_str += "c2_init_pb path: " + c2_init_pb + "\n"
  153. c2_init_net = caffe2_pb2.NetDef()
  154. with open(c2_init_pb, 'rb') as f:
  155. len_read = c2_init_net.ParseFromString(f.read())
  156. debug_str += "c2_init_pb ParseFromString = " + str(len_read) + "\n"
  157. c2_init_net.name = model_name + '_init'
  158. with open(os.path.join(model_dir, 'value_info.json')) as f:
  159. value_info = json.load(f)
  160. return c2_init_net, c2_predict_net, value_info, debug_str
  161. def get_c2_model(self, model_name):
  162. init_net, predict_net, value_info, _ = self.get_c2_model_dbg(model_name)
  163. return init_net, predict_net, value_info
  164. if __name__ == "__main__":
  165. parser = argparse.ArgumentParser(
  166. description='Download or install pretrained models.')
  167. parser.add_argument('model', nargs='+',
  168. help='Model to download/install.')
  169. parser.add_argument('-i', '--install', action='store_true',
  170. help='Install the model.')
  171. parser.add_argument('-f', '--force', action='store_true',
  172. help='Force a download/installation.')
  173. args = parser.parse_args()
  174. for model in args.model:
  175. if validModelName(model):
  176. downloadModel(model, args)
  177. else:
  178. print("'{}' is not a valid model name.".format(model))