作者|facebookresearch
編譯|Flin
來源|Github

detectron2.config package

class detectron2.config.CfgNode(init_dict=None,key_list=None,new_allowed=False)

• 原始碼：https://detectron2.readthedocs.io/_modules/detectron2/config/config.html#CfgNode

• 基類： fvcore.common.config.CfgNode

• 與fvcore.common.config.CfgNode相同,但不同之處在於：

1. 預設情況下使用不安全的Yaml載入。
   請注意,這可能會導致任意程式碼執行：在手動檢查檔案內容之前,切勿從不受信任的源中載入配置檔案。
2. 支援配置版本控制。
   嘗試合併舊配置時,它將自動轉換舊配置。

merge_from_file(cfg_filename: str,allow_unsafe: bool = True) → None

dump(*args,**kwargs)

• 返回值：str –配置的yaml字串表示形式

DEPRECATED_KEYS= ‘__deprecated_keys__‘

IMMUTABLE= ‘__immutable__‘

NEW_ALLOWED= ‘__new_allowed__‘
 

RENAMED_KEYS=‘__renamed_keys__‘

__init__(init_dict=None,new_allowed=False)

• 引數：
  • init_dict(dict)–可能巢狀的字典,用於初始化CfgNode。
  • key_list(list [ str ])–名稱列表,從根目錄索引此CfgNode。當前僅用於記錄目的。
  • new_allowed(bool)–與其他配置合併時是否允許新增新金鑰。

clear() → None,從D刪除所有專案

clone()

• 遞迴複製此CfgNode。

copy() → D的淺副本

defrost()

• 使此CfgNode及其所有子級可變。

freeze()

• 使此CfgNode及其所有子代不變。

fromkeys()

• 使用可迭代的鍵並將值設定為value建立一個新字典。

get()

• 如果key在字典中,則返回key的值,否則返回預設值。

is_frozen()

• 返回可變性。

is_new_allowed()

items() → 提供D的專案檢視的類集合物件

key_is_deprecated(full_key)

• 測試是否不贊成使用金鑰。

key_is_renamed(full_key)

• 測試金鑰是否被重新命名。

keys() → 提供D鍵檢視的類集合物件

class method load_cfg(cfg_file_obj_or_str)

• 載入cfg：param cfg_file_obj_or_str：支援從以下位置載入：

  • 由YAML檔案支援的檔案物件
  • 由Python原始檔支援的檔案物件,該檔案物件匯出dict或CfgNode屬性"cfg"
  • 可以解析為有效YAML的字串

static load_yaml_with_base(filename: str,allow_unsafe: bool = False)

就像yaml.load(open(filename))一樣,但是從其繼承屬性

• 引數：
  • filename(str)：當前配置的檔名。將用於查詢基本配置檔案。
  • allow_unsafe(bool)：是否允許使用yaml.unsafe_load載入配置檔案 。
  • 返回值：(字典) 已載入的Yaml

merge_from_list(cfg_list: list)

• 引數： cfg_list(list)：要合併的配置列表。

merge_from_other_cfg(cfg_other)

• 引數： cfg_other(CfgNode)要合併的配置。

pop(k[,d]) → v,remove specified key and return the corresponding value.

• 如果找不到鍵,則返回d(如果給出),否則引發KeyError

popitem() → (k,v),remove and return some (key,value) pair as a

• 2元組; 但如果D為空,則引發KeyError。

raise_key_rename_error(full_key)

register_deprecated_key(key)

• 註冊金鑰(例如FOO.BAR)已棄用的選項。合併不贊成使用的金鑰時,將生成警告,並且該金鑰將被忽略。

register_renamed_key(old_name,new_name,message=None)

• 將金鑰註冊為從old_name重新命名為new_name。合併重新命名的金鑰時,會引發異常,警告使用者該金鑰已被重新命名。

setdefault()

• 如果key不在字典中,則插入具有預設值的key。

• 如果key在字典中,否則返回預設值。

update([E,]**F) → None. Update D from dict/iterable E and F.

• 如果E存在並且具有.keys()方法,則執行：for k in E: D[k] = E[k]
• 如果E存在並且缺乏.keys()方法,則執行： for k,v in E: D[k] = v
• 在任一情況下,都跟著： for k in F: D[k] = F[k]

values() → 提供D值檢視的物件

detectron2.config.get_cfg() → detectron2.config.config.CfgNode

• 原始碼：https://detectron2.readthedocs.io/_modules/detectron2/config/config.html#get_cfg
• 獲取預設配置的副本。
• 返回值： 一個detectron2 CfgNode例項。

detectron2.config.set_global_cfg(cfg: detectron2.config.config.CfgNode) → None

• 原始碼：https://detectron2.readthedocs.io/_modules/detectron2/config/config.html#set_global_cfg
  讓全域性配置指向給定的cfg。

假定給定的"cfg"具有鍵"KEY",在呼叫 set_global_cfg(cfg)之後,可以通過以下方式訪問該鍵：

from detectron2.config import global_cfg
print(global_cfg.KEY)

通過使用hacky全域性配置,你可以在任何地方訪問這些配置,而不必將配置物件或值傳遞到程式碼中。這是為快速原型設計/研究探索而引入的一項功能強大的功能。

detectron2.config.downgrade_config(cfg: detectron2.config.config.CfgNode,to_version: int) → detectron2.config.config.CfgNode

• 原始碼：https://detectron2.readthedocs.io/_modules/detectron2/config/compat.html#downgrade_config

• 將配置從當前版本降級到舊版本。

• 引數：

  • cfg(CfgNode)
  • to_version(int)

注意

由於不同版本中的功能不同,通常無法對任意配置進行普遍降級。降級的目的僅是恢復舊版本中的預設設定,從而允許它載入舊的部分Yaml配置。因此,僅當無法進行一般降級時,實現才需要填寫舊版本中的預設值。

detectron2.config.upgrade_config(cfg: detectron2.config.config.CfgNode,to_version: Optional[int] = None) → detectron2.config.config.CfgNode

• 原始碼：https://detectron2.readthedocs.io/_modules/detectron2/config/compat.html#upgrade_config

• 將配置從當前版本升級到更高版本。

• 引數：

  • cfg(CfgNode)
  • to_version(int)預設為最新版本。