🌍 OmniOpt2-Share

What is OmniOpt2-Share?

OmniOpt2-Share allows you to Share your results with others, online. You can simply submit a job by

./omniopt_share runs/my_experiment/0

The program will upload the job to our server, and allow give you a link to it which is valid for 30 days.

--help

Option	Description
--update	Update a job that had this run-UUID previously
--debug	Enable debug options
--no_color	Disables color output
--force	Ignores cache
--username	Specify username (with or without = sign)
--dont_send_singleruns	Don't send single runs
--outfile	Path to the outfile

Run locally in Docker

It is possible to run OmniOpt-Share locally, via Docker.

cd .gui
bash docker.sh --local-port 1234 --shares-path /tmp/shares_stuff
echo "http://localhost:1234/" > ~/.oo_base_url

From there on, you will push OmniOpt2-Share to your local machine, reachable under localhost:1234 .

Download all exports

If you want to download a lot of exports, you can first run the local docker installation. Submit every job you want to the local OmniOpt2 installation (see the previous point).
You can then download all exports as single HTML files by simply doing this:

cd .gui
bash download_local_exports --export_dir /home/YourUsername/test/randomtest_98580

The download_local_exports script has some options to filter which jobs you want to export:

Option	Description
--user	Optional: Filter by user
--experiment	Optional: Filter by experiment
--autosubmit	Optional: Auto submit each job in runs before trying to export
--username	Optional: Name of the user if it should be submitted, defaults to $USER
--export_dir	Required: Directory to save exported HTML files

Run it like this:

bash download_local_exports --export_dir /home/YourUsername/test/randomtest_98580 --user YourUsername --experiment MY_EXPERIMENT_NAME

Download exported shares via curl

If you want to automatically download exported shares, ie. over curl, you can do the following:

URL="https://imageseg.scads.de/omniax/share?user_id=norman&sort=time_desc&experiment_name=__main__tests__BOTORCH_MODULAR___nogridsearch_nr_results_2&sort=time_desc&run_nr=0&sort=time_desc"
curl $URL | awk '/<!-- export.html -->/{p=!p; next} p' | perl -MHTML::Entities -pe 'decode_entities($_)' > name_of_your_exported_file.html

Of course, you need to adapt the URL to your use case.

Filter out certain subpages via URL

When exporting, and, for example, you do not want the Evolution and Errors page to be exported, you can add the parameter filter_tabs_regex=Errors|Evolution . Only valid characters here are [A-Za-z0-9\s()|] . This uses the tab names, and does a simple case-insensitive regex on them to filter them out.

Automatically share (--live_share )

When using --live_share with OmniOpt2, the job is shared automatically after each finished job. A URL where you can reach the Job and a QR-Code is printed as well, so you can easily access the site from anywhere in the world.

Notes on Privacy