Skip to content

Commit

Permalink
Cleanup an uncompleted doc
Browse files Browse the repository at this point in the history
  • Loading branch information
stanbrub committed Oct 18, 2023
1 parent 7a30de4 commit 0d87457
Showing 1 changed file with 0 additions and 25 deletions.
25 changes: 0 additions & 25 deletions docs/demo/NightlyDashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,3 @@ with urlopen(root + '/deephaven-benchmark/benchmark_tables.dh.py') as r:
benchmark_max_runs_arg = 5 # Latest X runs to include
exec(r.read().decode(), globals(), locals())
```
The script works with the benchmark data stored on this demo system but also works in any
[Deephaven Community Core](https://deephaven.io/core/docs/) instance that has
internet connectivity. Copy the script and any additions you have made to another
Deephaven notebook and run just as you did here.

## How Does This Python Snippet Work?

The following is a line-by-line walkthrough of what the above script is doing:
1. Import the [_urllib.request_](https://docs.python.org/3/library/urllib.request.html) package and set up _urlopen_ for use
2. Blank
3. Detect the parent location of the benchmark data; local Deephaven data directory or GCloud data directory
4. Open the *benchmark_tables* script from the discovered parent location
5. Tell the *benchmark_tables* script where the benchmark data is
6. Tell the *benchmark_tables* script what set of data to process
7. Tell the *benchmark_tables* script how many benchmark runs to include
8. Execute the *benchmark_tables* script to generate the tables

Script Arguments:
1. *benchmark_storage_uri_arg*:
- Where to load benchmark data from (don't change if you want to use Deephaven data storage)
2. *benchmark_category_arg*:
- _release_ for benchmarks collected on a specific [Deephaven releases](https://github.com/deephaven/deephaven-core/releases)
- _nightly_ for benchmarks collected every night
3. *benchmark_max_runs_arg*:
- The number of benchmark runs to include, starting from latest

0 comments on commit 0d87457

Please sign in to comment.