Skip to content

Commit

Permalink
Merge branch 'main' into run-clever
Browse files Browse the repository at this point in the history
da-ekchajzer committed Dec 16, 2024
2 parents 7f03117 + 99c1992 commit c21f554
Showing 5 changed files with 595 additions and 12 deletions.
2 changes: 1 addition & 1 deletion boaviztapi/data/crowdsourcing/cpu_specs.csv
Original file line number Diff line number Diff line change
@@ -50,7 +50,7 @@ AMD EPYC 7371,Naples,,,,,,,32.0,,,,,,,,AMD,EPYC,https://github.com/cloud-carbon-
AMD EPYC 7373X,Milan-X,EPYC (Zen 3 (Milan)),TSMC,2022-03-22,3.05 GHz,240.0,16.0,32.0,"33,200 million",7.0,8x 81 mm²,416 mm²,12 nm,1064.0,io_die_size (416 mm²) + die_size (8x 81 mm²),AMD,EPYC,https://www.techpowerup.com/cpu-specs/epyc-7373x.c2762
AMD EPYC 73F3,Milan,EPYC (Zen 3 (Milan)),TSMC,2021-03-15,3.5 GHz,240.0,16.0,32.0,"33,200 million",7.0,8x 81 mm²,416 mm²,12 nm,1064.0,io_die_size (416 mm²) + die_size (8x 81 mm²),AMD,EPYC,https://www.techpowerup.com/cpu-specs/epyc-73f3.c2387
AMD EPYC 7401,Naples,,,,,,,48.0,,,,,,,,AMD,EPYC,https://github.com/cloud-carbon-footprint/cloud-carbon-coefficients/tree/main/data
AMD EPYC 7401P,Naples,,,,,,,48.0,,,,,,,,AMD,EPYC,https://github.com/cloud-carbon-footprint/cloud-carbon-coefficients/tree/main/data
AMD EPYC 7401P,Naples,,,,,170.0,,48.0,,,,,,,,AMD,EPYC,https://www.techpowerup.com/cpu-specs/epyc-7401p.c1930
AMD EPYC 7402,Rome,EPYC (Zen 2 (Rome)),TSMC,2019-08-07,2.8 GHz,180.0,24.0,48.0,"3,800 million",7.0,6x 74 mm²,416 mm2,14 nm,860.0,io_die_size (416 mm2) + die_size (6x 74 mm²),AMD,EPYC,https://www.techpowerup.com/cpu-specs/epyc-7402.c2252
AMD EPYC 7402P,Rome,EPYC (Zen 2 (Rome)),TSMC,2019-08-07,2.8 GHz,180.0,24.0,48.0,"3,800 million",7.0,6x 74 mm²,416 mm2,14 nm,860.0,io_die_size (416 mm2) + die_size (6x 74 mm²),AMD,EPYC,https://www.techpowerup.com/cpu-specs/epyc-7402p.c2261
AMD EPYC 7413,Milan,EPYC (Zen 3 (Milan)),TSMC,2021-03-15,2.65 GHz,180.0,24.0,48.0,"16,600 million",7.0,4x 81 mm²,416 mm²,12 nm,740.0,io_die_size (416 mm²) + die_size (4x 81 mm²),AMD,EPYC,https://www.techpowerup.com/cpu-specs/epyc-7413.c2386
27 changes: 23 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -11,27 +11,46 @@ Content:
5. Getting started: some basic API queries explained.
6. How to guides - for developers who want to use the API

## Install & launch a local documentation server
## Work on the documentation

### Install the documentation tools

Documentation is generated from markdown using `mkdocs` with the `material` theme.

```bash
# install mkdocs and its extensions
# (preferred) Install mkdocs and its extensions
poetry install --with docs

# (old way) install mkdocs and its extensions
pip install mkdocs mkdocs-render-swagger-plugin mkdocs-material mkdocs-macros-plugin
```

💡 Do not mixup _pip_ and _brew_ installation of `mkdocs` (see [troubleshooting](https://jimandreas.github.io/mkdocs-material/troubleshooting/)).

### Launch a local documentation server

```bash
# If mkdocs is installed via poetry (preferred)
# from the root of the cloned repository
cd docs
poetry run mkdocs serve
```

```bash
# If mkdocs is installed globally
# from the root of the cloned repository
cd docs
mkdocs serve
```

Open <http://localhost:8080>

## Access latest published documentation using docker
### Verify the links

```bash
docker run ghcr.io/boavizta/tools-doc:latest
cd docs
# Check the warnings in the output for broken links
poetry run mkdocs build
# Test validity of external links
poetry run poetry run linkcheckMarkdown --recurse --verbose docs
```
4 changes: 2 additions & 2 deletions docs/docs/Explanations/auto_complete.md
Original file line number Diff line number Diff line change
@@ -4,9 +4,9 @@ Any calculation using the API is made easier thanks to the **data auto-complete

the API implements several approaches to complete the missing information:

* ```COMPELETE``` : The API infer the value based on the user inputs (e.g. `manufacturer` and `family` for a CPU ```name```).
* ```COMPLETE``` : The API infer the value based on the user inputs (e.g. `manufacturer` and `family` for a CPU ```name```).
* ```DEFAULT``` : The API use a default value for those missing attributes (e.g. europe for the default ```usage_location```). The default values can be set in the [configuration file](../config.md).
* ```ARCETYPE``` : The API can use a value taken from an [archetype](archetypes.md).
* ```ARCHETYPE``` : The API can use a value taken from an [archetype](archetypes.md).
* ```CHANGED```: The API can change the value of an attribute to make the computation possible. This happens when you provide a value that is close to the value of an attribute but not exactly the same. For example, if you provide a ```family``` that is not in the database but is close to a family in the database, the API will change the ```family``` to the closest name in the database.

The documentation about how attributes are auto-completed is given on each asset's documentation page.
573 changes: 568 additions & 5 deletions poetry.lock

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -39,6 +39,7 @@ mkdocs = "^1.5.3"
mkdocs-material = "^9.4.4"
mkdocs-render-swagger-plugin = "^0.1.0"
mkdocs-macros-plugin = "^1.0.4"
linkcheckmd = "^1.4.0"

[build-system]
requires = ["poetry-core"]

0 comments on commit c21f554

Please sign in to comment.