Skip to content

Commit

Permalink
docs: use smaller titles
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelrince committed Mar 1, 2024
1 parent 235c6f9 commit 2d9e73f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ GenAI Impact
**GenAI Impact** tracks and estimates the energy consumption and environmental impacts of using generative AI models through APIs.


# ⚙️ Installation
## ⚙️ Installation

Coming soon...

# 🚀 Usage
## 🚀 Usage

```python
from genai_impact import OpenAI
Expand All @@ -32,9 +32,9 @@ print(response.impacts) # Impacts(energy=0.025, energy_unit='Wh', ...)

See package documentation on [GenAI Impact](<link-to-mkdocs-material>)

# 💪 Contributing
## 💪 Contributing

## Requirements
### Requirements

Have [poetry](https://python-poetry.org/docs/#installation) installed on your system.

Expand All @@ -60,14 +60,14 @@ pip install poetry
</details>


## Install project
### Install project

```shell
poetry install --with dev,docs
```


## Run tests
### Run tests

```shell
tox -vv
Expand All @@ -80,7 +80,7 @@ poetry run pytest
```


## Run pre-commit hooks locally
### Run pre-commit hooks locally

[Install pre-commit](https://pre-commit.com/)

Expand Down

0 comments on commit 2d9e73f

Please sign in to comment.