documentation

Author: priyakasimbeg

scoring/score_submissions.py

@@ -7,9 +7,10 @@
 
 Example usage:
 python3 score_submissions.py \
-  --submission_directory $HOME/algorithmic-efficiency/prize_qualification_baselines/logs \
-  --strict True
-  --compute_performance_profiles
+  --submission_directory $HOME/algoperf-runs/submissions/rolling_leaderboard/self_tuning \
+  --compute_performance_profiles \
+  --output_dir scoring_results_self_tuning \
+  --self_tuning_ruleset
 """
 
 import operator

scoring/utils/slurm/README.md

@@ -1 +1,5 @@
-This folder contains a SLURM batch script that can be used to run jobs where each job corresponds to a training run on a given workload, training algorithm, random seed and tuning trial (if on external tuning ruleset)
+This folder contains a SLURM batch script that can be used to run jobs where each job corresponds to a training run on a given workload, training algorithm, random seed and tuning trial (if on external tuning ruleset).
+
+To launch jobs:
+1) Generate a job config
+`python make_job_config.py`

scoring/utils/slurm/make_job_config.py

@@ -1,3 +1,11 @@
+"""
+Usage:
+python3 make_job_config.py \
+  --submission_path <submission_path> \
+  --tuning_search_space <tuning_search_space> \
+  --experiment_dir $HOME/experiments/<algorithm> \
+  --framework <jax|pytorch>
+"""
 import json
 import os
 
@@ -13,10 +21,10 @@
 
 flags.DEFINE_string('submission_path',
                     SUBMISSION_PATH,
-                    'Path to submission module.')
+                    'Path to submission module relative to algorithmic-efficiency dir.')
 flags.DEFINE_string('tuning_search_space',
                     TUNING_SEARCH_SPACE,
-                    'Path to tuning search space for submission module.')
+                    'Path to tuning search space for submission module relative to algorithmic-efficiency dir.')
 flags.DEFINE_string('experiment_dir',
                     EXPERIMENT_DIR,
                     'Path to experiment dir where logs will be saved.')