Skip to content

Commit

Permalink
fix: update license, README and yarn LOCK file
Browse files Browse the repository at this point in the history
  • Loading branch information
notoraptor committed May 3, 2022
1 parent 35bb1b4 commit c563cc7
Show file tree
Hide file tree
Showing 3 changed files with 793 additions and 1,028 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Software License Agreement (BSD License)

Copyright (c) 2020-2021, Epistímio.
Copyright (c) 2020-2022, Epistímio.
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
28 changes: 23 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@
This code provides a common Orion dashboard to display experiments and benchmarks.

Orion Dashboard is heavily based on
`Carbon's React Tutorial <https://www.carbondesignsystem.com/developing/react-tutorial/overview>`_.

===========================
Oríon Dashboard (Prototype)
===========================

This is a very preleminary prototype of a dashboard for Oríon. Most of it are
Orion Dashboard for experiments
-------------------------------

This is a very preliminary prototype of a dashboard for Oríon. Most of it are
just place-holders and static data to show visualizations.

This prototype is heavily based on
`Carbon's React Tutorial <https://www.carbondesignsystem.com/developing/react-tutorial/overview>`_.
===============================
Dashboard for Oríon's Benchmark
===============================

Oríon's `benchmark <https://orion.readthedocs.io/en/stable/user/benchmark.html>`_ makes it easy
to execute multiple hyperparameter optimization algorithms on several tasks. You can
assess the average result over multiple runs of the algorithms or automatically benchmark
how well they parallelize to large pools of workers. It quickly becomes difficult however to
analyse all the data generated by these benchmarks, as large number of tasks and assessments can lead to
hundreds of potential plots. It can also be challenging to track the progress of hundreds of experiments,
each consisting of hundreds of trials. This dashboard serves as a centralized interface to visualize
the results of the benchmarks and to monitor their progress.

=============
Installations
-------------
=============

This dashboard uses React and Carbon. You will need to install npm first, and then yarn.

Expand All @@ -27,7 +45,7 @@ Install all dependencies including Carbon.
Host
----

You can start the server with
You can start the server with

.. code-block:: console
Expand Down
Loading

0 comments on commit c563cc7

Please sign in to comment.