omniopt2 6983__tar.gz → 7006__tar.gz

{omniopt2-6983 → omniopt2-7006}/.omniopt.py

@@ -87,6 +87,15 @@ try:
     with console.status("[bold green]Importing argparse..."):
         import argparse
 
+    with console.status("[bold green]Importing rich_argparse...") as status:
+        from argparse import HelpFormatter
+
+        try:
+            from rich_argparse import RichHelpFormatter
+            Formatter: type[HelpFormatter] = RichHelpFormatter
+        except ModuleNotFoundError:
+            Formatter = HelpFormatter
+
     with console.status("[bold green]Importing datetime..."):
         import datetime
 
@@ -583,7 +592,7 @@ class ConfigLoader:
             prog="omniopt",
             description='A hyperparameter optimizer for slurm-based HPC-systems',
             epilog=f"Example:\n\n{oo_call} --partition=alpha --experiment_name=neural_network ...",
-            formatter_class=argparse.HelpFormatter
+            formatter_class=Formatter
         )
 
         self.parser.add_argument('--config_yaml', help='YAML configuration file', type=str, default=None)

{omniopt2-6983 → omniopt2-7006}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: omniopt2
-Version: 6983
+Version: 7006
 Summary: Automatic highly parallelized hyperparameter optimizer based on Ax/Botorch
 Home-page: https://scads.ai/transfer-2/verfuegbare-software-dienste-en/omniopt/
 Author: Norman Koch
@@ -42,6 +42,7 @@ Requires-Dist: setuptools
 Requires-Dist: pyright
 Requires-Dist: qrcode
 Requires-Dist: tabulate
+Requires-Dist: rich-argparse
 Requires-Dist: shellcheck-py
 Requires-Dist: vulture
 Requires-Dist: flake8
@@ -108,7 +109,7 @@ scientists with hyperparameter optimization on SLURM-based clusters, even
 though it works without it as well. It simplifies large-scale optimization
 tasks with built-in fault tolerance and flexibility. A graphical user interface
 (GUI) is available for command creation, accessible at 
-[OmniOpt2 GUI](https://imageseg.scads.de/omniax/). For tutorials on 
+[OmniOpt2 GUI](https://imageseg.scads.de/omniax/gui). For tutorials on 
 configuration, exit codes, and debugging, visit
 [OmniOpt2 Tutorials](https://imageseg.scads.de/omniax/tutorials).
 
@@ -139,6 +140,12 @@ omniopt_plot --run_dir runs/example/0
 omniopt_plot --run_dir runs/example/0 --min 0 --max 100
 ```
 
+## Using live-share
+
+Use `--live_share` (also enablable via GUI) to automatically share the job. You will get a URL
+where your job data is hosted publically for 30 days, meaning everyone can access your results,
+and you can see all kinds of visualizations and export them.
+
 ## Run Tests (Developer Use Only)
 
 The test suite simulates various scenarios, including handling faulty
@@ -154,13 +161,13 @@ for more details.
 
 ## Install from pypi
 
-This may not use the latest version.
+This may not use the bleeding-edge version, but if you get the version from here it means, the test suite has completety tested it properly.
 
 ```command
 pip3 install omniopt2
 ```
 
-## Install from repo
+## Install from repo (bleeding edge, may contain untested changes)
 
 ```command
 pip3 install -e git+https://github.com/NormanTUD/OmniOpt2.git#egg=OmniOpt2
@@ -188,6 +195,10 @@ to install them.
 
 I'd be glad to see your contributions!
 
+## Issues
+
+If you experience any problems, please write issues at my [Github Issues page](https://github.com/NormanTUD/OmniOpt/issues).
+
 ## Old OmniOpt
 
 The old OmniOpt version, based on HyperOpt, is not supported anymore. It is still available, though, at [https://github.com/NormanTUD/LegacyOmniOpt](https://github.com/NormanTUD/LegacyOmniOpt).

{omniopt2-6983 → omniopt2-7006}/README.md

@@ -7,7 +7,7 @@ scientists with hyperparameter optimization on SLURM-based clusters, even
 though it works without it as well. It simplifies large-scale optimization
 tasks with built-in fault tolerance and flexibility. A graphical user interface
 (GUI) is available for command creation, accessible at 
-[OmniOpt2 GUI](https://imageseg.scads.de/omniax/). For tutorials on 
+[OmniOpt2 GUI](https://imageseg.scads.de/omniax/gui). For tutorials on 
 configuration, exit codes, and debugging, visit
 [OmniOpt2 Tutorials](https://imageseg.scads.de/omniax/tutorials).
 
@@ -38,6 +38,12 @@ omniopt_plot --run_dir runs/example/0
 omniopt_plot --run_dir runs/example/0 --min 0 --max 100
 ```
 
+## Using live-share
+
+Use `--live_share` (also enablable via GUI) to automatically share the job. You will get a URL
+where your job data is hosted publically for 30 days, meaning everyone can access your results,
+and you can see all kinds of visualizations and export them.
+
 ## Run Tests (Developer Use Only)
 
 The test suite simulates various scenarios, including handling faulty
@@ -53,13 +59,13 @@ for more details.
 
 ## Install from pypi
 
-This may not use the latest version.
+This may not use the bleeding-edge version, but if you get the version from here it means, the test suite has completety tested it properly.
 
 ```command
 pip3 install omniopt2
 ```
 
-## Install from repo
+## Install from repo (bleeding edge, may contain untested changes)
 
 ```command
 pip3 install -e git+https://github.com/NormanTUD/OmniOpt2.git#egg=OmniOpt2
@@ -87,6 +93,10 @@ to install them.
 
 I'd be glad to see your contributions!
 
+## Issues
+
+If you experience any problems, please write issues at my [Github Issues page](https://github.com/NormanTUD/OmniOpt/issues).
+
 ## Old OmniOpt
 
 The old OmniOpt version, based on HyperOpt, is not supported anymore. It is still available, though, at [https://github.com/NormanTUD/LegacyOmniOpt](https://github.com/NormanTUD/LegacyOmniOpt).

{omniopt2-6983 → omniopt2-7006}/omniopt2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: omniopt2
-Version: 6983
+Version: 7006
 Summary: Automatic highly parallelized hyperparameter optimizer based on Ax/Botorch
 Home-page: https://scads.ai/transfer-2/verfuegbare-software-dienste-en/omniopt/
 Author: Norman Koch
@@ -42,6 +42,7 @@ Requires-Dist: setuptools
 Requires-Dist: pyright
 Requires-Dist: qrcode
 Requires-Dist: tabulate
+Requires-Dist: rich-argparse
 Requires-Dist: shellcheck-py
 Requires-Dist: vulture
 Requires-Dist: flake8
@@ -108,7 +109,7 @@ scientists with hyperparameter optimization on SLURM-based clusters, even
 though it works without it as well. It simplifies large-scale optimization
 tasks with built-in fault tolerance and flexibility. A graphical user interface
 (GUI) is available for command creation, accessible at 
-[OmniOpt2 GUI](https://imageseg.scads.de/omniax/). For tutorials on 
+[OmniOpt2 GUI](https://imageseg.scads.de/omniax/gui). For tutorials on 
 configuration, exit codes, and debugging, visit
 [OmniOpt2 Tutorials](https://imageseg.scads.de/omniax/tutorials).
 
@@ -139,6 +140,12 @@ omniopt_plot --run_dir runs/example/0
 omniopt_plot --run_dir runs/example/0 --min 0 --max 100
 ```
 
+## Using live-share
+
+Use `--live_share` (also enablable via GUI) to automatically share the job. You will get a URL
+where your job data is hosted publically for 30 days, meaning everyone can access your results,
+and you can see all kinds of visualizations and export them.
+
 ## Run Tests (Developer Use Only)
 
 The test suite simulates various scenarios, including handling faulty
@@ -154,13 +161,13 @@ for more details.
 
 ## Install from pypi
 
-This may not use the latest version.
+This may not use the bleeding-edge version, but if you get the version from here it means, the test suite has completety tested it properly.
 
 ```command
 pip3 install omniopt2
 ```
 
-## Install from repo
+## Install from repo (bleeding edge, may contain untested changes)
 
 ```command
 pip3 install -e git+https://github.com/NormanTUD/OmniOpt2.git#egg=OmniOpt2
@@ -188,6 +195,10 @@ to install them.
 
 I'd be glad to see your contributions!
 
+## Issues
+
+If you experience any problems, please write issues at my [Github Issues page](https://github.com/NormanTUD/OmniOpt/issues).
+
 ## Old OmniOpt
 
 The old OmniOpt version, based on HyperOpt, is not supported anymore. It is still available, though, at [https://github.com/NormanTUD/LegacyOmniOpt](https://github.com/NormanTUD/LegacyOmniOpt).

{omniopt2-6983 → omniopt2-7006}/omniopt2.egg-info/requires.txt

@@ -32,6 +32,7 @@ setuptools
 pyright
 qrcode
 tabulate
+rich-argparse
 shellcheck-py
 vulture
 flake8

{omniopt2-6983 → omniopt2-7006}/pyproject.toml

@@ -5,7 +5,7 @@ authors = [
   {email = "norman.koch@tu-dresden.de"},
   {name = "Norman Koch"}
 ]
-version = "6983"
+version = "7006"
 
 readme = "README.md"
 dynamic = ["dependencies"]

{omniopt2-6983 → omniopt2-7006}/requirements.txt

@@ -32,3 +32,4 @@ setuptools
 pyright
 qrcode
 tabulate
+rich-argparse