Commit 7b4bc9cf authored by Yuxin Wu's avatar Yuxin Wu

update docs and deprecation

parent b6aced91
......@@ -18,6 +18,7 @@ def backup_collection(keys):
"""
Args:
keys (list): list of collection keys to backup
Returns:
dict: the backup
"""
......
......@@ -41,6 +41,7 @@ def apply_grad_processors(opt, gradprocs):
opt (tf.train.Optimizer):
gradprocs (list[GradientProcessor]): gradient processors to add to the
optimizer.
Returns:
a :class:`tf.train.Optimizer` instance which runs the gradient
processors before updating the variables.
......
......@@ -84,19 +84,9 @@ def get_dataset_path(*args):
"""
d = os.environ.get('TENSORPACK_DATASET', None)
if d is None:
old_d = os.path.abspath(os.path.join(
os.path.dirname(__file__), '..', 'dataflow', 'dataset'))
old_d_ret = os.path.join(old_d, *args)
new_d = os.path.join(os.path.expanduser('~'), 'tensorpack_data')
if os.path.isdir(old_d_ret):
# there is an old dir containing data, use it for back-compat
logger.warn("You seem to have old data at {}. This is no longer \
the default location. You'll need to move it to {} \
(the new default location) or another directory set by \
$TENSORPACK_DATASET.".format(old_d, new_d))
d = new_d
d = os.path.join(os.path.expanduser('~'), 'tensorpack_data')
if execute_only_once():
logger.warn("$TENSORPACK_DATASET not set, using {} for dataset.".format(d))
logger.warn("Env var $TENSORPACK_DATASET not set, using {} for datasets.".format(d))
if not os.path.isdir(d):
mkdir_p(d)
logger.info("Created the directory {}.".format(d))
......
......@@ -44,6 +44,8 @@ _RNG_SEED = None
def fix_rng_seed(seed):
"""
Call this function at the beginning of program to fix rng seed within tensorpack.
Args:
seed (int):
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment