fix: readme

Author: jharlow-intel

benchmarks/README.md

@@ -4,20 +4,16 @@ Benchmarking dpctl using Airspeed Velocity
 Read more about ASV [here](https://asv.readthedocs.io/en/stable/index.html)
 
 ## Usage
-This was made for use within our CI in mind. As such, you will see the `asv.conf.json` is minimal without any environmental information supplied.
+The benchmarks were made with using an existing environment in-mind before execution. You will see the `asv.conf.json` is minimal without any environmental information supplied.
 The expectation is for users to execute `asv run` with an existing environment.
 
-As such, you should have conda or mamba installed, and create a `dpctl-benchmarking` environment as so:
-```
-conda create --name dpctl-benchmarking python=$PYTHON_VERSION dpctl asv libmambapy conda dpcpp_linux-64 --override-channels \
-        -c https://software.repos.intel.com/python/conda \
-        -c conda-forge -y
-```
+As such, you should have conda or mamba installed, and create an environment [following these instructions](https://intelpython.github.io/dpctl/latest/beginners_guides/installation.html#dpctl-installation)
+Additionally, install `asv` and `libmambapy` to the environment.
 
-Then, you may activate the environment and instruct `asv run` to use this existing environment for the benchmarks by pointing it to thhe environment's python binary, like so:
+Then, you may activate the environment and instruct `asv run` to use this existing environment for the benchmarks by pointing it to the environment's python binary, like so:
 ```
-conda activate dpctl-benchmarking
-asv run --environment existing:/full/mamba/path/envs/dpctl-benchmarking/bin/python
+conda activate dpctl_env
+asv run --environment existing:/full/mamba/path/envs/dpctl_env/bin/python
 ```
 
 ## Writing new benchmarks

benchmarks/asv.conf.json

@@ -13,24 +13,13 @@
     // project being benchmarked
     "repo": "..",
 
-    // The Python project's subdirectory in your repo.  If missing or
-    // the empty string, the project is assumed to be located at the root
-    // of the repository.
-    // "repo_subdir": "",
-
     // Customizable commands for building the project.
     // See asv.conf.json documentation.
     "build_command": [],
 
-    // Customizable commands for installing and uninstalling the project.
-    // See asv.conf.json documentation.
-    // "install_command": ["in-dir={env_dir} conda install dpctl --yes"],
-    // "uninstall_command": ["return-code=any conda uninstall dpctl --yes"],
-
     // List of branches to benchmark. If not provided, defaults to "main"
     // (for git) or "default" (for mercurial).
-    "branches": ["HEAD"], // for git
-    // "branches": ["default"],    // for mercurial
+    "branches": ["HEAD"],
 
     // The DVCS being used.  If not set, it will be automatically
     // determined from "repo" by looking at the protocol in the URL
@@ -46,92 +35,6 @@
     // variable.
     "environment_type": "conda",
 
-    // timeout in seconds for installing any dependencies in environment
-    // defaults to 10 min
-    //"install_timeout": 600,
-
-    // the base URL to show a commit for the project.
-    // "show_commit_url": "http://github.com/owner/project/commit/",
-
-    // The Pythons you'd like to test against.  If not provided, defaults
-    // to the current version of Python used to run `asv`.
-    // "pythons": ["3.8", "3.12"],
-
-    // The list of conda channel names to be searched for benchmark
-    // dependency packages in the specified order
-    // "conda_channels": [
-    //     "https://af01p-igk.devtools.intel.com/artifactory/api/conda/idp-conda-pkgserver-igk-local/gold",
-    //     "https://af01p-igk.devtools.intel.com/artifactory/api/conda/idp-conda-pkgserver-igk-local/tools",
-    //     "conda-forge"
-    // ],
-
-    // A conda environment file that is used for environment creation.
-    // "conda_environment_file": "environment.yml",
-
-    // The matrix of dependencies to test.  Each key of the "req"
-    // requirements dictionary is the name of a package (in PyPI) and
-    // the values are version numbers.  An empty list or empty string
-    // indicates to just test against the default (latest)
-    // version. null indicates that the package is to not be
-    // installed. If the package to be tested is only available from
-    // PyPi, and the 'environment_type' is conda, then you can preface
-    // the package name by 'pip+', and the package will be installed
-    // via pip (with all the conda available packages installed first,
-    // followed by the pip installed packages).
-    //
-    // The ``@env`` and ``@env_nobuild`` keys contain the matrix of
-    // environment variables to pass to build and benchmark commands.
-    // An environment will be created for every combination of the
-    // cartesian product of the "@env" variables in this matrix.
-    // Variables in "@env_nobuild" will be passed to every environment
-    // during the benchmark phase, but will not trigger creation of
-    // new environments.  A value of ``null`` means that the variable
-    // will not be set for the current combination.
-    //
-    // "matrix": {
-    //     "env": {"PACKAGE_PATH": [""]}
-    // },
-
-    // Combinations of libraries/python versions can be excluded/included
-    // from the set to test. Each entry is a dictionary containing additional
-    // key-value pairs to include/exclude.
-    //
-    // An exclude entry excludes entries where all values match. The
-    // values are regexps that should match the whole string.
-    //
-    // An include entry adds an environment. Only the packages listed
-    // are installed. The 'python' key is required. The exclude rules
-    // do not apply to includes.
-    //
-    // In addition to package names, the following keys are available:
-    //
-    // - python
-    //     Python version, as in the *pythons* variable above.
-    // - environment_type
-    //     Environment type, as above.
-    // - sys_platform
-    //     Platform, as in sys.platform. Possible values for the common
-    //     cases: 'linux2', 'win32', 'cygwin', 'darwin'.
-    // - req
-    //     Required packages
-    // - env
-    //     Environment variables
-    // - env_nobuild
-    //     Non-build environment variables
-    //
-    // "exclude": [
-    //     {"python": "3.2", "sys_platform": "win32"}, // skip py3.2 on windows
-    //     {"environment_type": "conda", "req": {"six": null}}, // don't run without six on conda
-    //     {"env": {"ENV_VAR_1": "val2"}}, // skip val2 for ENV_VAR_1
-    // ],
-    //
-    // "include": [
-    //     // additional env for python3.12
-    //     {"python": "3.12", "req": {"numpy": "1.26"}, "env_nobuild": {"FOO": "123"}},
-    //     // additional env if run on windows+conda
-    //     {"platform": "win32", "environment_type": "conda", "python": "3.12", "req": {"libpython": ""}},
-    // ],
-
     // The directory (relative to the current directory) that benchmarks are
     // stored in.  If not provided, defaults to "benchmarks"
     "benchmark_dir": "benchmarks",
@@ -146,37 +49,5 @@
 
     // The directory (relative to the current directory) that the html tree
     // should be written to.  If not provided, defaults to "html".
-    "html_dir": ".asv/html",
-
-    // The number of characters to retain in the commit hashes.
-    // "hash_length": 8,
-
-    // `asv` will cache results of the recent builds in each
-    // environment, making them faster to install next time.  This is
-    // the number of builds to keep, per environment.
-    // "build_cache_size": 2,
-
-    // The commits after which the regression search in `asv publish`
-    // should start looking for regressions. Dictionary whose keys are
-    // regexps matching to benchmark names, and values corresponding to
-    // the commit (exclusive) after which to start looking for
-    // regressions.  The default is to start from the first commit
-    // with results. If the commit is `null`, regression detection is
-    // skipped for the matching benchmark.
-    //
-    // "regressions_first_commits": {
-    //    "some_benchmark": "352cdf",  // Consider regressions only after this commit
-    //    "another_benchmark": null,   // Skip regression detection altogether
-    // },
-
-    // The thresholds for relative change in results, after which `asv
-    // publish` starts reporting regressions. Dictionary of the same
-    // form as in ``regressions_first_commits``, with values
-    // indicating the thresholds.  If multiple entries match, the
-    // maximum is taken. If no entry matches, the default is 5%.
-    //
-    // "regressions_thresholds": {
-    //    "some_benchmark": 0.01,     // Threshold of 1%
-    //    "another_benchmark": 0.5,   // Threshold of 50%
-    // },
+    "html_dir": ".asv/html"
 }