From e36cb1fe9c264f300ab8ee6eaf5b176cdb2b4088 Mon Sep 17 00:00:00 2001 From: "David J. Kowalk" Date: Mon, 25 Nov 2024 14:27:23 +0100 Subject: [PATCH 1/2] Changed link within repository to be dynamic, because the link was broken. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index da9b3859..fafb25ec 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ python3 -m pip uninstall physbo ## Usage -['examples/simple.py'](https://github.com/issp-center-dev/PHYSBO/examples/simple.py) is a simple example. +['examples/simple.py'](./examples/simple.py) is a simple example. ## Data repository From e0bb3abf4da31b59ff117e3a9a030ff7e9015b1b Mon Sep 17 00:00:00 2001 From: "David J. Kowalk" Date: Mon, 25 Nov 2024 14:33:58 +0100 Subject: [PATCH 2/2] Linked the tutorial in the README file for good form, Changed Titles to English standard titles --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fafb25ec..1ed494ea 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A standard implementation (e.g., scikit-learn), however, can accommodate only sm PHYSBO is highly scalable due to an efficient protocol that employs Thompson sampling, random feature maps, one-rank Cholesky update and automatic hyperparameter tuning. Technical features are described in [COMBO's document](https://github.com/tsudalab/combo/blob/master/docs/combo_document.pdf) and [PHYSBO's report](https://doi.org/10.1016/j.cpc.2022.108405) (open access). PHYSBO was developed based on [COMBO](https://github.com/tsudalab/combo) for academic use. -## Document +## Documentation - Stable (master branch) - [English](https://issp-center-dev.github.io/PHYSBO/manual/master/en/index.html) @@ -14,7 +14,7 @@ PHYSBO was developed based on [COMBO](https://github.com/tsudalab/combo) for aca - [English](https://issp-center-dev.github.io/PHYSBO/manual/develop/en/index.html) - [日本語](https://issp-center-dev.github.io/PHYSBO/manual/develop/ja/index.html) -## Required Packages +## Dependencies - Python >= 3.6 - No longer tested with Python 3.6 @@ -61,6 +61,8 @@ python3 -m pip uninstall physbo ## Usage +For an introductory tutorial please consult the documentation. ([English](https://issp-center-dev.github.io/PHYSBO/manual/master/en/notebook/tutorial_basic.html) / [日本語](https://issp-center-dev.github.io/PHYSBO/manual/develop/ja/install.html#id2)) + ['examples/simple.py'](./examples/simple.py) is a simple example. ## Data repository