Skip to content

Commit 6c8a08b

Browse files
committed
Intermediate changes: apply comments, bug fixes
1 parent e318f64 commit 6c8a08b

26 files changed

+419
-321
lines changed

README.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,31 @@
11
# Machine Learning Benchmarks
22

3-
[Developer Guide](docs/README.md)
4-
53
[![Build Status](https://dev.azure.com/daal/scikit-learn_bench/_apis/build/status/IntelPython.scikit-learn_bench?branchName=main)](https://dev.azure.com/daal/scikit-learn_bench/_build/latest?definitionId=8&branchName=main)
64

7-
**Scikit-learn_bench** is a benchmarking tool for libraries and frameworks implementing Scikit-learn-like APIs and other workloads.
5+
**Scikit-learn_bench** is a benchmark tool for libraries and frameworks implementing Scikit-learn-like APIs and other workloads.
86

9-
Features:
7+
Benefits:
108
- Full control of benchmarks suite through CLI
11-
- Flexible and powerful benchmarking config structure
12-
- Ability to run with advanced profiling tools (*Intel(R) VTune(TM)* and others)
9+
- Flexible and powerful benchmark config structure
10+
- Available with advanced profiling tools, such as Intel(R) VTune* Profiler
1311
- Automated generation of benchmarks report
1412

15-
## 📜 Table of content
13+
### 📜 Table of Contents
1614

1715
- [Machine Learning Benchmarks](#machine-learning-benchmarks)
18-
- [📜 Table of content](#-table-of-content)
19-
- [🔧 How to create Python environment for benchmarking](#-how-to-create-python-environment-for-benchmarking)
20-
- [🚀 How to use scikit-learn\_bench](#-how-to-use-scikit-learn_bench)
21-
- [Benchmarks runner](#benchmarks-runner)
22-
- [Report generator](#report-generator)
23-
- [Scikit-learn\_bench high-level workflow](#scikit-learn_bench-high-level-workflow)
24-
- [📚 Benchmark types](#-benchmark-types)
25-
- [📑 Documentation tree](#-documentation-tree)
16+
- [🔧 Create a Python Environment](#-create-a-python-environment)
17+
- [🚀 How To Use Scikit-learn\_bench](#-how-to-use-scikit-learn_bench)
18+
- [Benchmarks Runner](#benchmarks-runner)
19+
- [Report Generator](#report-generator)
20+
- [Scikit-learn\_bench High-Level Workflow](#scikit-learn_bench-high-level-workflow)
21+
- [📚 Benchmark Types](#-benchmark-types)
22+
- [📑 Documentation](#-documentation)
2623

27-
## 🔧 How to create Python environment for benchmarking
24+
## 🔧 Create a Python Environment
2825

29-
Create a suitable Python environment to use depending on needed frameworks:
26+
Create a suitable Python environment to use depending on the needed frameworks:
3027

31-
- **sklearn, sklearnex and gradient boosting frameworks**:
28+
- **sklearn, sklearnex, and gradient boosting frameworks**:
3229

3330
```bash
3431
# with pip
@@ -43,41 +40,41 @@ conda env create -n sklearn -f envs/conda-env-sklearn.yml
4340
conda env create -n rapids --solver=libmamba -f envs/conda-env-rapids.yml
4441
```
4542

46-
## 🚀 How to use scikit-learn_bench
43+
## 🚀 How To Use Scikit-learn_bench
4744

48-
### Benchmarks runner
45+
### Benchmarks Runner
4946

50-
Call required benchmarking cases from specified config using `sklbench` module as runner:
47+
Call required benchmarking cases from specified config using the `sklbench` module as a runner:
5148

5249
```bash
5350
python -m sklbench --config configs/sklearn_example.json
5451
```
5552

56-
Default output of runner is a file with JSON-formatted results of benchmarking cases. To generate better human-readable report inplace, you can request it by adding specific argument:
53+
The default output is a file with JSON-formatted results of benchmarking cases. To generate a better human-readable report, use the following command:
5754

5855
```bash
5956
python -m sklbench --config configs/sklearn_example.json --generate-report
6057
```
6158

62-
By default output and report file paths are `result.json` and `report.xlsx`. Add next argument to specify custom file paths:
59+
By default, output and report file paths are `result.json` and `report.xlsx`. To specify custom file paths, run:
6360

6461
```bash
6562
python -m sklbench --config configs/sklearn_example.json --generate-report --result-file result_example.json --report-file report_example.xlsx
6663
```
6764

68-
For description of all benchmarks runner arguments, see [it's corresponding docs section](sklbench/runner/README.md#arguments).
65+
For a description of all benchmarks runner arguments, refer to [documentation](sklbench/runner/README.md#arguments).
6966

70-
### Report generator
67+
### Report Generator
7168

72-
Raw result files gathered from different environments can be combined by calling report generator:
69+
To combine raw result files gathered from different environments, call the report generator:
7370

7471
```bash
7572
python -m sklbench.report --result-files result_1.json result_2.json --report-file report_example.xlsx
7673
```
7774

78-
For description of all report generator arguments, see [it's corresponding docs section](sklbench/report/README.md#arguments).
75+
For a description of all report generator arguments, refer to [documentation](sklbench/report/README.md#arguments).
7976

80-
### Scikit-learn_bench high-level workflow
77+
### Scikit-learn_bench High-Level Workflow
8178

8279
```mermaid
8380
flowchart TB
@@ -90,19 +87,18 @@ flowchart TB
9087
class A userStyle
9188
```
9289

93-
## 📚 Benchmark types
90+
## 📚 Benchmark Types
9491

95-
**Scikit-learn_bench** supports next types of benchmarks:
92+
**Scikit-learn_bench** supports the following types of benchmarks:
9693

97-
- `Scikit-learn estimator` benchmark which measures performance and quality metrics of [sklearn-like estimator](https://scikit-learn.org/stable/glossary.html#term-estimator).
98-
- `Function` benchmark which measures performance metrics of specified function.
94+
- **Scikit-learn estimator** - Measures performance and quality metrics of the [sklearn-like estimator](https://scikit-learn.org/stable/glossary.html#term-estimator).
95+
- **Function** - Measures performance metrics of specified function.
9996

100-
## 📑 Documentation tree
97+
## 📑 Documentation
10198
[Scikit-learn_bench](README.md):
10299
- [Configs](configs/README.md)
103-
- [Benchmarking config specification](configs/BENCH-CONFIG-SPEC.md)
104-
- [Benchmarks runner](sklbench/runner/README.md)
105-
- [Report generator](sklbench/report/README.md)
100+
- [Benchmarks Runner](sklbench/runner/README.md)
101+
- [Report Generator](sklbench/report/README.md)
106102
- [Benchmarks](sklbench/benchmarks/README.md)
107-
- [Data processing](sklbench/datasets/README.md)
103+
- [Data Processing](sklbench/datasets/README.md)
108104
- [Developer Guide](docs/README.md)

configs/BENCH-CONFIG-SPEC.md

Lines changed: 0 additions & 152 deletions
This file was deleted.

0 commit comments

Comments
 (0)