search

uma-pi1 / kge

LibKGE - A knowledge graph embedding library for reproducible research
MIT License
765 stars 124 forks source link

can you write some detailed tutorial on writing configuration file? #247

Closed lihuiliullh closed 2 years ago

lihuiliullh commented 2 years ago

can you write some detailed tutorial on writing configuration file? Currently, I find out that the way to learn how to write configuration file is very limited. I read those examples you give, but still barely understand it.

job.type: train dataset.name: fb15k-237

train: optimizer: Adagrad optimizer_args: lr: 0.2

valid: every: 5 metric: mean_reciprocal_rank_filtered

model: complex lookup_embedder: dim: 100 regularize_weight: 0.8e-7

rufex2001 commented 2 years ago

My suggestions would be to:

  1. Get familiat with the YAML format
  2. Go through the config-default.yaml file to get familiar with the available configuration options
  3. Get familiar with the examples in the examples folder to see how to combine general config keys with model or embedder specific keys.
  4. See something like the following file for an example of a search config file:

https://github.com/uma-pi1/kge-iclr20/blob/master/config_files/iclr2020/fb15k-237/complex-1vsAll-kl/config.yaml

  1. Modify all of the above to produce the config file you need.

On Sat, 20 Nov 2021, 05:35 lihuiliullh, @.***> wrote:

can you write some detailed tutorial on writing configuration file? Currently, I find out that the way to learn how to write configuration file is very limited. I read those examples you give, but still barely understand it.

job.type: train dataset.name: fb15k-237

train: optimizer: Adagrad optimizer_args: lr: 0.2

valid: every: 5 metric: mean_reciprocal_rank_filtered

model: complex lookup_embedder: dim: 100 regularize_weight: 0.8e-7

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/uma-pi1/kge/issues/247, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABEWXZGZAZF3GOKHYW4R4QTUM4QPNANCNFSM5INQUCAQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

rgemulla commented 2 years ago

@lihuiliullh As @rufex2001 said, the config options are well-documented in config-default.yaml

@rufex2001 Perhaps we should point out more clearly that this file is the one to look for documentation.

rgemulla commented 2 years ago

Added a FAQ entry.