Update project and HPO documentation (pykeen#492)

* Update project and HPO documentation

* More documentation updates

* Update __init__.py

* Add dashes to "hyperparameter"

* Fix type annotation

[skip ci]

* Doocument bad ranges

* More updates based on max's comments

* Fix type annotations

* Make fit API

* Update docs

* Add fixme for HPO with no dataset

This should have been done in pykeen#483

* Update docs

* Add check and unittest for invalid configurations

Author: cthoyt

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 PyKEEN Project Team
+Copyright (c) 2019-2020 PyKEEN Project Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -196,7 +196,7 @@ in ``pykeen``.
 | Hits At K               | The hits at k for different values of k, i.e. the relative frequency of ranks not larger than k. Higher is better. | rankbased   | `pykeen.evaluation.RankBasedMetricResults` |
 | Adjusted Mean Rank      | The mean over all chance-adjusted ranks: mean_i (2r_i / (num_entities+1)). Lower is better.                        | rankbased   | `pykeen.evaluation.RankBasedMetricResults` |
 
-## Hyperparameter Optimization
+## Hyper-parameter Optimization
 
 ### Samplers (2)
 

docs/source/conf.py

@@ -46,8 +46,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pykeen'
-copyright = '2019, Mehdi Ali'
-author = 'Mehdi Ali'
+copyright = '2020, PyKEEN Project Team'
+author = 'PyKEEN Project Team'
 
 # The full version, including alpha/beta/rc tags.
 release = '0.1.2-dev'
@@ -170,8 +170,11 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (
-        master_doc, 'pykeen.tex', 'pykeen Documentation',
-        'Mehdi Ali', 'manual',
+        master_doc,
+        'pykeen.tex',
+        'PyKEEN Documentation',
+        author,
+        'manual',
     ),
 ]
 
@@ -181,8 +184,11 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     (
-        master_doc, 'pykeen', 'pykeen Documentation',
-        [author], 1,
+        master_doc,
+        'pykeen',
+        'PyKEEN Documentation',
+        [author],
+        1,
     ),
 ]
 
@@ -193,8 +199,12 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
-        master_doc, 'pykeen', 'pykeen Documentation',
-        author, 'pykeen', 'One line description of project.',
+        master_doc,
+        'pykeen',
+        'PyKEEN Documentation',
+        author,
+        'PyKEEN Project Team',
+        'Training and evaluatation knowledge graph embedding models.',
         'Miscellaneous',
     ),
 ]

docs/source/first_steps.rst

@@ -41,3 +41,8 @@ executed with one of the previous examples.
     # Evaluate
     results = evaluator.evaluate(mapped_triples, batch_size=1024)
     print(results)
+
+Optimizing a Model
+------------------
+.. automodule:: pykeen.hpo
+    :noindex:

docs/source/reference/hpo.rst

@@ -1,8 +1,10 @@
 Hyper-parameter Optimization
 ============================
-.. automodule:: pykeen.hpo
-   :members:
+.. autoclass:: pykeen.hpo.HpoPipelineResult
+    :members:
 
-.. seealso::
+.. autofunction:: pykeen.hpo.hpo_pipeline_from_path
 
-   - https://towardsdatascience.com/a-conceptual-explanation-of-bayesian-model-based-hyperparameter-optimization-for-machine-learning-b8172278050f
+.. autofunction:: pykeen.hpo.hpo_pipeline_from_config
+
+.. autofunction:: pykeen.hpo.hpo_pipeline