fastreid.utils.env Namespace Reference

Functions
	seed_all_rng (seed=None)
	_import_file (module_name, file_path, make_importable=False)
	_configure_libraries ()
	setup_environment ()
	setup_custom_environment (custom_module)

Variables
	TORCH_VERSION = tuple(int(x) for x in torch.__version__.split(".")[:2])
bool	_ENV_SETUP_DONE = False

Function Documentation

_configure_libraries()

fastreid.utils.env._configure_libraries ( )

protected

Configurations for some libraries.

Definition at line 50 of file env.py.

def _configure_libraries():
    """
    Configurations for some libraries.
    """
    # An environment option to disable `import cv2` globally,
    # in case it leads to negative performance impact
    disable_cv2 = int(os.environ.get("DETECTRON2_DISABLE_CV2", False))
    if disable_cv2:
        sys.modules["cv2"] = None
    else:
        # Disable opencl in opencv since its interaction with cuda often has negative effects
        # This envvar is supported after OpenCV 3.4.0
        os.environ["OPENCV_OPENCL_RUNTIME"] = "disabled"
        try:
            import cv2
 
            if int(cv2.__version__.split(".")[0]) >= 3:
                cv2.ocl.setUseOpenCL(False)
        except ImportError:
            pass
 
    def get_version(module, digit=2):
        return tuple(map(int, module.__version__.split(".")[:digit]))
 
    # fmt: off
    assert get_version(torch) >= (1, 4), "Requires torch>=1.4"
    import yaml
    assert get_version(yaml) >= (5, 1), "Requires pyyaml>=5.1"
    # fmt: on
 
 

_import_file()

fastreid.utils.env._import_file ( module_name, file_path, make_importable = False )

protected

Definition at line 41 of file env.py.

def _import_file(module_name, file_path, make_importable=False):
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    if make_importable:
        sys.modules[module_name] = module
    return module
 
 

seed_all_rng()

fastreid.utils.env.seed_all_rng

(

seed = None

)

Set the random seed for the RNG in torch, numpy and python.
Args:
    seed (int): if None, will use a strong random seed.

Definition at line 21 of file env.py.

def seed_all_rng(seed=None):
    """
    Set the random seed for the RNG in torch, numpy and python.
    Args:
        seed (int): if None, will use a strong random seed.
    """
    if seed is None:
        seed = (
            os.getpid()
            + int(datetime.now().strftime("%S%f"))
            + int.from_bytes(os.urandom(2), "big")
        )
        logger = logging.getLogger(__name__)
        logger.info("Using a generated random seed {}".format(seed))
    np.random.seed(seed)
    torch.set_rng_state(torch.manual_seed(seed).get_state())
    random.seed(seed)
 
 
# from https://stackoverflow.com/questions/67631/how-to-import-a-module-given-the-full-path

setup_custom_environment()

fastreid.utils.env.setup_custom_environment

(

custom_module

)

Load custom environment setup by importing a Python source file or a
module, and run the setup function.

Definition at line 106 of file env.py.

def setup_custom_environment(custom_module):
    """
    Load custom environment setup by importing a Python source file or a
    module, and run the setup function.
    """
    if custom_module.endswith(".py"):
        module = _import_file("fastreid.utils.env.custom_module", custom_module)
    else:
        module = importlib.import_module(custom_module)
    assert hasattr(module, "setup_environment") and callable(module.setup_environment), (
        "Custom environment module defined in {} does not have the "
        "required callable attribute 'setup_environment'."
    ).format(custom_module)
    module.setup_environment()

setup_environment()

fastreid.utils.env.setup_environment

(

)

Perform environment setup work. The default setup is a no-op, but this
function allows the user to specify a Python source file or a module in
the $FASTREID_ENV_MODULE environment variable, that performs
custom setup work that may be necessary to their computing environment.

Definition at line 84 of file env.py.

def setup_environment():
    """Perform environment setup work. The default setup is a no-op, but this
    function allows the user to specify a Python source file or a module in
    the $FASTREID_ENV_MODULE environment variable, that performs
    custom setup work that may be necessary to their computing environment.
    """
    global _ENV_SETUP_DONE
    if _ENV_SETUP_DONE:
        return
    _ENV_SETUP_DONE = True
 
    _configure_libraries()
 
    custom_module_path = os.environ.get("FASTREID_ENV_MODULE")
 
    if custom_module_path:
        setup_custom_environment(custom_module_path)
    else:
        # The default setup is a no-op
        pass
 
 

Variable Documentation

_ENV_SETUP_DONE

bool fastreid.utils.env._ENV_SETUP_DONE = False

protected

Definition at line 81 of file env.py.

TORCH_VERSION

fastreid.utils.env.TORCH_VERSION = tuple(int(x) for x in torch.__version__.split(".")[:2])

Definition at line 15 of file env.py.