如何在python中使用gin庫(kù)

這篇文章將為大家詳細(xì)講解有關(guān)如何在python中使用gin庫(kù)，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

Python主要用來(lái)做什么

Python主要應(yīng)用于：1、Web開(kāi)發(fā)；2、數(shù)據(jù)科學(xué)研究；3、網(wǎng)絡(luò)爬蟲(chóng)；4、嵌入式應(yīng)用開(kāi)發(fā)；5、游戲開(kāi)發(fā)；6、桌面應(yīng)用開(kāi)發(fā)。

安裝

pip install gin-config

2.@gin.configurable

任何函數(shù)和類(lèi)都可以使用@gin.configurable裝飾器

@gin.configurable
def my_network(images, num_outputs, num_layers=3, weight_decay=1e-4):
  ...

@gin.configurable裝飾器做了如下三件事：

1. 把類(lèi)或函數(shù)聲明成了可配置的東西

2. 它決定了函數(shù)或類(lèi)構(gòu)造函數(shù)的哪些參數(shù)是可配置的(默認(rèn)情況下是其所有的參數(shù))

3. 封裝類(lèi)或函數(shù)，攔截調(diào)用，并向函數(shù)的可配置參數(shù)提供來(lái)自參數(shù)設(shè)置全局注冊(cè)表的值（這些值是類(lèi)或函數(shù)聲明時(shí)沒(méi)有指定的值）

為了確定哪些是可以配置的參數(shù)，@gin.configurable會(huì)使用到allowlist和denylist參數(shù)，分別聲明哪些是可配的哪些是不可配的，我們通常用一個(gè)即可，默認(rèn)沒(méi)有用allowlist指定的都為不可配，反之亦然。

@gin.configurable('supernet', denylist=['images'])
def my_network(images, num_outputs, num_layers=3, weight_decay=1e-4):
  ...

其中supernet是我們指定的配置名。

3.賦值

我們使用如下兩種格式給參數(shù)賦值：

1. gin.bind_parameter('configurable_name.parameter_name', value)


2. configurable_name.parameter_name = value

具體例子分別如下：

gin.bind_parameter('supernet.num_layers', 5)
gin.bind_parameter('supernet.weight_decay', 1e-3)

supernet.num_layers = 5
supernet.weight_decay = 1e-3

4.取值

我們可以用gin.query_parameter來(lái)取值，具體例子如下

num_layers = gin.query_parameter('supernet.num_layers')
weight_decay = gin.query_parameter('supernet.weight_decay')

5.配置參考文件

假如我們有以下代碼：

@gin.configurable
class DNN(object):
  def __init__(self, num_units=(1024, 1024)):
    ...
  def __call__(inputs, num_outputs):
    ...

@gin.configurable(denylist=['data'])
def train_model(network_fn, data, learning_rate, optimizer):
  ...

我們可以在gin文件里配置參數(shù)：

train_model.network_fn = @DNN()  # An instance of DNN is passed.
train_model.optimizer = @MomentumOptimizer  # The class itself is passed.
train_model.learning_rate = 0.001

DNN.num_units = (2048, 2048, 2048)
MomentumOptimizer.momentum = 0.9

上面顯示了兩種配置參數(shù)風(fēng)格。@DNN()和@MomentumOptimizer。對(duì)于前者將會(huì)調(diào)用DNN類(lèi)的實(shí)例參數(shù)，且每次參數(shù)配置都會(huì)隨著每個(gè)DNN類(lèi)的實(shí)例變動(dòng)。對(duì)于后者將會(huì)調(diào)用類(lèi)MomentumOptimizer的默認(rèn)參數(shù)。

6.使用gin文件

我們經(jīng)常會(huì)和absl下flags一起使用gin，比如下面這樣

from absl import flags

flags.DEFINE_multi_string(
  'gin_file', None, 'List of paths to the config files.')
flags.DEFINE_multi_string(
  'gin_param', None, 'Newline separated list of Gin parameter bindings.')

FLAGS = flags.FLAGS

然后主程序main.py里最先解析參數(shù)：

gin.parse_config_files_and_bindings(FLAGS.gin_file, FLAGS.gin_param)

假設(shè)我們參數(shù)文件example.gin在當(dāng)前目錄下,則運(yùn)行時(shí)，我們?cè)诮K端輸入python main.py --gin_file=example.gin

也可以在代碼里改成這樣：

flags.DEFINE_multi_string(
  'gin_file', ["example.gin"], 'List of paths to the config files.')

然后直接運(yùn)行

6.調(diào)用其他類(lèi)或函數(shù)

我們可以用下面代碼調(diào)用其他類(lèi)或函數(shù)的參數(shù)，甚至這個(gè)類(lèi)或函數(shù)可以在其他項(xiàng)目里。

gin.external_configurable(tf.train.MomentumOptimizer)

7.范圍限定

當(dāng)一個(gè)可配置函數(shù)在程序執(zhí)行過(guò)程中被多次調(diào)用時(shí)，可能需要為每次調(diào)用提供不同的參數(shù)綁定。Gin提供了一個(gè)范圍限定機(jī)制來(lái)促進(jìn)這一點(diǎn)。
例如，假設(shè)我們想要實(shí)現(xiàn)一個(gè)GAN，我們必須交替訓(xùn)練一個(gè)生成器和一個(gè)鑒別器。在Tensoflow中，這最容易通過(guò)兩個(gè)優(yōu)化器來(lái)實(shí)現(xiàn)，因此我們可能有這樣一個(gè)函數(shù):

gin.external_configurable(tf.train.GradientDescentOptimizer)

@gin.configurable(allowlist=['generator_optimizer', 'discriminator_optimizer'])
def gan_trainer(
    generator_loss, generator_vars, generator_optimizer,
    discriminator_loss, discriminator_vars, discriminator_optimizer):
  # Construct the optimizers and minimize w.r.t. the correct variables.
  generator_train_op = generator_optimizer().minimize(
      generator_loss, generator_vars)
  discriminator_train_op = discriminator_optimizer().minimize(
      discriminator_loss, discriminator_vars)
  ...

我們?nèi)绾螌?code>generator_optimizer和discriminator_optimizer都配置為@GradientDescentOptimizer，但具有不同的學(xué)習(xí)速率？
下面是個(gè)錯(cuò)誤示范：

# Won't work!
gan_trainer.generator_optimizer = @GradientDescentOptimizer
GradientDescentOptimizer.learning_rate = 0.01

gan_trainer.discriminator_optimizer = @GradientDescentOptimizer
# This binding will overwrite the previous one:
GradientDescentOptimizer.learning_rate = 0.001

Gin提供了一個(gè)范圍界定機(jī)制來(lái)處理這種情況。任何可配置引用的前面都可以有一個(gè)作用域名稱，用/字符與可配置名稱分開(kāi)。同樣，也可以通過(guò)在可配置名稱前面加上一個(gè)范圍名稱來(lái)應(yīng)用特定于某個(gè)范圍的綁定。
下面是對(duì)的示范：

# This will work! Use scoping to apply different parameter bindings.
gan_trainer.generator_optimizer = @generator/GradientDescentOptimizer
gan_trainer.discriminator_optimizer = @discriminator/GradientDescentOptimizer

generator/GradientDescentOptimizer.learning_rate = 0.01
discriminator/GradientDescentOptimizer.learning_rate = 0.001

8.標(biāo)記gin參數(shù)

Gin允許您指示在Gin配置中必須提供某些參數(shù)。這可以通過(guò)兩種方式實(shí)現(xiàn):
1.在函數(shù)的調(diào)用位置
2.在函數(shù)的簽名中

當(dāng)調(diào)用一個(gè)可配置時(shí)，您可以通過(guò)gin.REQUIRED標(biāo)記任何arg或kwarg。所需對(duì)象:

my_network(images, gin.REQUIRED, num_layers=5, weight_decay=gin.REQUIRED)

將在調(diào)用時(shí)檢查所需參數(shù)。如果沒(méi)有為這些參數(shù)提供Gin綁定，將會(huì)引發(fā)一個(gè)錯(cuò)誤，列出缺少的參數(shù)綁定以及需要它們的可配置名稱。
定義可配置時(shí)，可以使用gin.REQUIRED將參數(shù)標(biāo)記為必需的：

@gin.configurable
def run_training(model_dir=gin.REQUIRED, network=gin.REQUIRED, ...):
  ...

9.從Gin文件中導(dǎo)入模塊

import some.module.spec

10.在Gin文件中調(diào)用另一個(gè)Gin文件參數(shù)

一個(gè)Gin文件可以包含其他Gin文件，這樣可以更容易地將一個(gè)配置拆分成單獨(dú)的組件(例如，一個(gè)“基礎(chǔ)”配置，它被其他派生配置包含和修改)。包含另一個(gè)Gin文件可以使用以下語(yǔ)法完成:

include 'path/to/another/file.gin'

11.Gin “macros”

有時(shí)一個(gè)值應(yīng)該在多個(gè)綁定之間共享。為了實(shí)現(xiàn)這一點(diǎn)并避免多次重復(fù)該值(導(dǎo)致維護(hù)負(fù)擔(dān))，Gin提供了以下預(yù)定義的可配置功能:

@gin.configurable
def macro(value):
  return value

可以引用“宏”函數(shù)(通過(guò)“()”來(lái)取值）。例如:

num_layers/macro.value = 10
network.num_layers = @num_layers/macro()

也可以這樣寫(xiě)

num_layers = 10
network.num_layers = %num_layers

12.常量

gin.constant函數(shù)可用于定義常量，這些常量可通過(guò)上述宏語(yǔ)法訪問(wèn)。例如，在Python中:

gin.constant('THE_ANSWER', 42)

然后在配置文件gin中

meaning.of_life = %THE_ANSWER

請(qǐng)注意，任何Python對(duì)象都可以用作常量的值(包括不能表示為Gin文字的對(duì)象)。值將被存儲(chǔ)到Gin內(nèi)部字典中，直到程序終止，因此避免創(chuàng)建具有有限生命周期的值的常數(shù)。
一個(gè)消除歧義的模塊可以放在常量名稱的前面。例如:

gin.constant('some.modules.PI', 3.14159)

13.實(shí)驗(yàn)使用多個(gè)Gin文件和額外的命令行綁定

在許多情況下，可以定義多個(gè)包含實(shí)驗(yàn)整體配置不同部分的Gin文件。對(duì)整體配置的額外“調(diào)整”可以通過(guò)命令行標(biāo)志作為單獨(dú)的綁定來(lái)傳遞。

一種推薦的方法是創(chuàng)建一個(gè)包含多個(gè)Gin配置的文件夾，然后創(chuàng)建一個(gè)包含以下內(nèi)容的BUILD文件:

filegroup(
    name = "gin_files",
    srcs = glob(["*.gin"]),
    visibility = [":internal"],
)

此filegroup可用作二進(jìn)制文件中的數(shù)據(jù)依賴項(xiàng):

data = ["//path/to/configs:gin_files",]

在二進(jìn)制文件中，可以定義以下標(biāo)志:

from absl import flags

flags.DEFINE_multi_string(
  'gin_file', None, 'List of paths to the config files.')
flags.DEFINE_multi_string(
  'gin_param', None, 'Newline separated list of Gin parameter bindings.')

FLAGS = flags.FLAGS

然后用Gin解析它們:

gin.parse_config_files_and_bindings(FLAGS.gin_file, FLAGS.gin_param)

最后，二進(jìn)制文件可以運(yùn)行為:

.../run_gin_eval \
  --gin_file=$CONFIGS_PATH/cartpole_balance.gin \
  --gin_file=$CONFIGS_PATH/base_dqn.gin \
  --gin_file=$CONFIGS_PATH/eval.gin \
  --gin_param='evaluate.num_episodes_eval = 10' \
  --gin_param='evaluate.generate_videos = False' \
  --gin_param='evaluate.eval_interval_secs = 60'

關(guān)于如何在python中使用gin庫(kù)就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。