Qingyun Wu 6c16e47e42
Bug fix and add documentation for metric_constraints (#498)
* metric constraint documentation

* update link

* update notebook

* fix a bug in adding 'time_total_s' to result

* use the default multiple factor from config file

* update notebook

* format

* improve test

* revise test budget for macos

* bug fix in adding time_total_s

* increase performance check budget

* revise test

* update notebook

* uncomment test

* remove redundancy

* clear output

* remove n_jobs

* remove constraint in notebook

* increase budget

* revise test

* add python version

* use getattr

* improve code robustness

Co-authored-by: Qingyun Wu <qxw5138@psu.edu>
2022-03-26 21:11:45 -04:00
..
2021-12-16 17:11:33 -08:00
2022-01-30 19:36:41 -08:00
2022-01-15 14:44:42 -08:00
2021-12-16 17:11:33 -08:00
2021-12-18 15:00:54 -08:00
2021-12-16 17:11:33 -08:00
2021-12-16 17:11:33 -08:00
2022-03-25 17:32:37 -07:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Prerequisites

To build and test documentation locally, begin by downloading and installing Node.js, and then installing Yarn. On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:

npm install --global yarn

Installation

pip install pydoc-markdown
cd website
yarn install

Local Development

Navigate to the website folder and run:

pydoc-markdown
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.