Skip to content

Commit c4f2f22

Browse files
f3rmionghiander
andauthored
Optuna dependency should be optional (#234)
* Fix Optuna dependency by Poetry dep group. * Make optuna dependecy group optional. * version bump and updated docs --------- Co-authored-by: Gian Marco Ghiandoni <[email protected]>
1 parent 6df22a8 commit c4f2f22

File tree

3 files changed

+91
-78
lines changed

3 files changed

+91
-78
lines changed

README.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Requirements
7272
rdkit # Chemoinformatics toolkit
7373
7474
75-
Installation
76-
------------
75+
Installation via PyPI
76+
---------------------
7777

7878
You can install *Jazzy* via pip_ from PyPI_:
7979

@@ -82,30 +82,38 @@ You can install *Jazzy* via pip_ from PyPI_:
8282
$ pip install jazzy
8383
8484
85-
Installation from Source
86-
------------------------
85+
Installation via Poetry (for development)
86+
-----------------------------------------
8787

88-
Requirements to install *Jazzy* from sources:
88+
Requirements to install *Jazzy* from the code repository:
8989

9090
- `poetry`_
9191
- `pyenv`_ or `conda`_
9292
- python>=3.6
9393

94-
First check that ``poetry`` is running correctly (v1.0.10 at the time of writing)
94+
First check that ``poetry`` is running (v1.4.1 at March 2023)
9595

9696
.. code:: console
9797
9898
$ poetry --version
99-
Poetry version 1.0.10
99+
Poetry version v1.4.1
100100
101-
Create a virtual environment (via ``pyenv`` or ``conda``) and activate it. Afterwards, clone the *Jazzy* project from GitHub and install it using ``poetry``
101+
Create a virtual environment (via ``pyenv`` or ``conda``) and activate it. Afterwards, clone the *Jazzy* project from GitHub and install it using ``poetry``.
102102

103103
.. code:: console
104104
105105
$ git clone [email protected]:AstraZeneca/jazzy.git
106106
$ cd jazzy
107107
$ poetry install
108108
109+
If you wish to replicate our parameter fitting (see ``data/optuna_fitting`` and ``optimisation``), you need to install the specific version of ``optuna``.
110+
At the time of the study, we used ``optuna==2.3.0``. You can install that manually using ``pip`` or ``poetry``.
111+
112+
.. code:: console
113+
114+
$ poetry install --with optuna
115+
$ pip freeze | grep optuna
116+
optuna==2.3.0
109117
110118
Usage and Cookbook
111119
------------------

0 commit comments

Comments
 (0)