Skip to content

Commit

Permalink
docs: improve docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
drudilorenzo committed Apr 27, 2024
1 parent aaffad8 commit 1f23136
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
OpenAI Cost Logger
==================

Simple **cost logger** for **OpenAI requests**.
Track the cost of every request you make to OpenAI and visualize them in a user-friendly way.
* Simple **cost logger** for **OpenAI requests**.
* Track the cost of every request you make to OpenAI and visualize them in a user-friendly way.
* Homepage on `PyPI <https://pypi.org/project/openai-cost-logger/>`_.
* `Demo file <https://github.com/drudilorenzo/track-openai-cost/blob/master/demo.ipynb>`_ with a usage example.

How to install:
---------------
Expand All @@ -21,9 +23,6 @@ How to install:
from openai_cost_logger import OpenAICostLoggerUtils
from openai_cost_logger import DEFAULT_LOG_PATH, MODELS_COST

* Homepage on `PyPI <https://pypi.org/project/openai-cost-logger/>`_.
* `Demo file <https://github.com/drudilorenzo/track-openai-cost/blob/master/demo.ipynb>`_ with a usage example.

Key Features:
-------------
* Track the cost of every request you make and save them in a JSON file.
Expand All @@ -41,6 +40,6 @@ Note:

Viz example:
-------------
.. image::https://drive.google.com/file/d/1lbmRJCe5VHqom0bdHzE2xi09lSfsp_Bm/view?usp=sharing
.. image:: https://drive.google.com/file/d/1lbmRJCe5VHqom0bdHzE2xi09lSfsp_Bm/view?usp=sharing
:alt: Viz example (prints + plot)
:align: center

0 comments on commit 1f23136

Please sign in to comment.