Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix instructions to add new model.
  • Loading branch information
samuelbroscheit authored May 27, 2020
1 parent e778df9 commit e37984a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ The [examples](examples) folder contains some configuration files as examples of

We welcome contributions to expand the list of supported models! Please see [CONTRIBUTING](CONTRIBUTING.md) for details and feel free to initially open an issue.

## Adding a new model
## Adding a new model or embedder

To add a new model to LibKGE, extend the
[KgeModel](https://github.com/uma-pi1/kge/blob/1c69d8a6579d10e9d9c483994941db97e04f99b3/kge/model/kge_model.py#L243)
Expand All @@ -385,8 +385,11 @@ to score triples given their embeddings.

The model implementation should be stored under
`<kge-home>/kge/model/<model-name>.py`, its configuration options under
`<kge-home>/kge/model/<model-name>.yaml`.
`<kge-home>/kge/model/<model-name>.yaml` and its import has to be added to `<kge-home>/kge/model/__init__.py`.

The embdedder implementation should be stored under
`<kge-home>/kge/model/embedder/<embedder-name>.py`, its configuration options under
`<kge-home>/kge/model/embedder/<embedder-name>.yaml` and its import has to be added to `<kge-home>/kge/model/__init__.py`.

## Known issues

Expand Down

0 comments on commit e37984a

Please sign in to comment.