asv.conf.json 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. {
  2. // The version of the config file format. Do not change, unless
  3. // you know what you are doing.
  4. "version": 1,
  5. // The name of the project being benchmarked
  6. "project": "rllib",
  7. // The project's homepage
  8. "project_url": "http://rllib.io",
  9. // The URL or local path of the source code repository for the
  10. // project being benchmarked
  11. "repo": "../../../",
  12. // List of branches to benchmark. If not provided, defaults to "master"
  13. // (for git) or "default" (for mercurial).
  14. "branches": ["master"], // for git
  15. // "branches": ["default"], // for mercurial
  16. // The DVCS being used. If not set, it will be automatically
  17. // determined from "repo" by looking at the protocol in the URL
  18. // (if remote), or by looking for special directories, such as
  19. // ".git" (if local).
  20. "dvcs": "git",
  21. // The tool to use to create environments. May be "conda",
  22. // "virtualenv" or other value depending on the plugins in use.
  23. // If missing or the empty string, the tool will be automatically
  24. // determined by looking for tools on the PATH environment
  25. // variable.
  26. "environment_type": "conda",
  27. // timeout in seconds for installing any dependencies in environment
  28. // defaults to 10 min
  29. //"install_timeout": 600,
  30. // the base URL to show a commit for the project.
  31. "show_commit_url": "http://github.com/ray-project/ray/commit/",
  32. // The Pythons you'd like to test against. If not provided, defaults
  33. // to the current version of Python used to run `asv`.
  34. "pythons": ["3.6"],
  35. // The matrix of dependencies to test. Each key is the name of a
  36. // package (in PyPI) and the values are version numbers. An empty
  37. // list or empty string indicates to just test against the default
  38. // (latest) version. null indicates that the package is to not be
  39. // installed. If the package to be tested is only available from
  40. // PyPi, and the 'environment_type' is conda, then you can preface
  41. // the package name by 'pip+', and the package will be installed via
  42. // pip (with all the conda available packages installed first,
  43. // followed by the pip installed packages).
  44. //
  45. // "matrix": {
  46. // "numpy": ["1.6", "1.7"],
  47. // "six": ["", null], // test with and without six installed
  48. // "pip+emcee": [""], // emcee is only available for install with pip.
  49. // },
  50. // Combinations of libraries/python versions can be excluded/included
  51. // from the set to test. Each entry is a dictionary containing additional
  52. // key-value pairs to include/exclude.
  53. //
  54. // An exclude entry excludes entries where all values match. The
  55. // values are regexps that should match the whole string.
  56. //
  57. // An include entry adds an environment. Only the packages listed
  58. // are installed. The 'python' key is required. The exclude rules
  59. // do not apply to includes.
  60. //
  61. // In addition to package names, the following keys are available:
  62. //
  63. // - python
  64. // Python version, as in the *pythons* variable above.
  65. // - environment_type
  66. // Environment type, as above.
  67. // - sys_platform
  68. // Platform, as in sys.platform. Possible values for the common
  69. // cases: 'linux2', 'win32', 'cygwin', 'darwin'.
  70. //
  71. // "exclude": [
  72. // {"python": "3.2", "sys_platform": "win32"}, // skip py3.2 on windows
  73. // {"environment_type": "conda", "six": null}, // don't run without six on conda
  74. // ],
  75. //
  76. // "include": [
  77. // // additional env for python2.7
  78. // {"python": "2.7", "numpy": "1.8"},
  79. // // additional env if run on windows+conda
  80. // {"platform": "win32", "environment_type": "conda", "python": "2.7", "libpython": ""},
  81. // ],
  82. // The directory (relative to the current directory) that benchmarks are
  83. // stored in. If not provided, defaults to "benchmarks"
  84. "benchmark_dir": "tuned_examples/regression_tests",
  85. // The directory (relative to the current directory) to cache the Python
  86. // environments in. If not provided, defaults to "env"
  87. // "env_dir": "env",
  88. // The directory (relative to the current directory) that raw benchmark
  89. // results are stored in. If not provided, defaults to "results".
  90. "results_dir": "RLLIB_RESULTS",
  91. // The directory (relative to the current directory) that the html tree
  92. // should be written to. If not provided, defaults to "html".
  93. // "html_dir": "html",
  94. // The number of characters to retain in the commit hashes.
  95. // "hash_length": 8,
  96. // `asv` will cache wheels of the recent builds in each
  97. // environment, making them faster to install next time. This is
  98. // number of builds to keep, per environment.
  99. // "wheel_cache_size": 0
  100. // The commits after which the regression search in `asv publish`
  101. // should start looking for regressions. Dictionary whose keys are
  102. // regexps matching to benchmark names, and values corresponding to
  103. // the commit (exclusive) after which to start looking for
  104. // regressions. The default is to start from the first commit
  105. // with results. If the commit is `null`, regression detection is
  106. // skipped for the matching benchmark.
  107. //
  108. // "regressions_first_commits": {
  109. // "some_benchmark": "352cdf", // Consider regressions only after this commit
  110. // "another_benchmark": null, // Skip regression detection altogether
  111. // }
  112. // The thresholds for relative change in results, after which `asv
  113. // publish` starts reporting regressions. Dictionary of the same
  114. // form as in ``regressions_first_commits``, with values
  115. // indicating the thresholds. If multiple entries match, the
  116. // maximum is taken. If no entry matches, the default is 5%.
  117. //
  118. // "regressions_thresholds": {
  119. // "some_benchmark": 0.01, // Threshold of 1%
  120. // "another_benchmark": 0.5, // Threshold of 50%
  121. // }
  122. }