From 67b3f23687c9d0663aad4855124f6837d34b89a3 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Tue, 23 Jul 2024 14:13:34 -0400
Subject: [PATCH] chore(deps-dev): bump types-setuptools from 70.3.0.20240710
 to 71.1.0.20240723 (#10)

* Update README.md

* chore(deps-dev): bump types-setuptools

Bumps [types-setuptools](https://github.com/python/typeshed) from 70.3.0.20240710 to 71.1.0.20240723.
- [Commits](https://github.com/python/typeshed/commits)

---
updated-dependencies:
- dependency-name: types-setuptools
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: LittleO <113553401+YuanhuanO@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
 README.md   | 40 ++++++++++++++++++++++++++++++++++++++++
 poetry.lock |  6 +++---
 2 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 6506a95..4822ff6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,43 @@
 # GPU Bartender
 
 Estimate the GPU VRAM usage in modern LLM training.
+
+## How to run GPU Bartender
+
+1. Clone the repository:
+
+    ```bash
+    git clone git@github.com:lwaekfjlk/gpu-bartender.git
+    ```
+
+2. Navigate to the frontend directory:
+
+    ```bash
+    cd gpu_bartender/src/frontend
+    ```
+
+3. Install dependencies:
+
+    ```bash
+    npm install
+    ```
+
+4. Build the project:
+
+    ```bash
+    npm run build
+    ```
+
+5. Start the application:
+
+    ```bash
+    npm start
+    ```
+
+6. Open your browser and navigate to [http://localhost:3000/](http://localhost:3000/)
+
+## Features
+
+- Estimate GPU VRAM usage for large language model (LLM) training.
+- User-friendly interface to input model parameters.
+- Real-time updates and visualizations of VRAM usage.
diff --git a/poetry.lock b/poetry.lock
index 9bcf1eb..cc62561 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1455,13 +1455,13 @@ test = ["argcomplete (>=3.0.3)", "mypy (>=1.7.0)", "pre-commit", "pytest (>=7.0,
 
 [[package]]
 name = "types-setuptools"
-version = "70.3.0.20240710"
+version = "71.1.0.20240723"
 description = "Typing stubs for setuptools"
 optional = false
 python-versions = ">=3.8"
 files = [
-    {file = "types-setuptools-70.3.0.20240710.tar.gz", hash = "sha256:842cbf399812d2b65042c9d6ff35113bbf282dee38794779aa1f94e597bafc35"},
-    {file = "types_setuptools-70.3.0.20240710-py3-none-any.whl", hash = "sha256:bd0db2a4b9f2c49ac5564be4e0fb3125c4c46b1f73eafdcbceffa5b005cceca4"},
+    {file = "types-setuptools-71.1.0.20240723.tar.gz", hash = "sha256:8a9349038c7e22d88e6c5d9c6705b347b22930424114a452c1712899e85131ff"},
+    {file = "types_setuptools-71.1.0.20240723-py3-none-any.whl", hash = "sha256:ac9fc263f59d1e02bca49cb7270a12c47ab80b3b911fb4d92f1fecf978bfe88a"},
 ]
 
 [[package]]