add instructions in readme

README.md

@@ -8,4 +8,30 @@ app_file: README.md
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+## How to use
+### 1. Create an account on [Beam](https://platform.beam.cloud/)
+### 2. Create a Python virtualenv and activate it
+```shell
+python3 -m venv .venv && source .venv/bin/activate
+```
+### 3. Install required packages
+```shell
+pip install -r requirements.txt
+```
+### 4. Register Beam API Token
+Retrieve your API token from the dashboard, on the [API Keys](https://platform.beam.cloud/settings/api-keys) page.
+```shell
+beam configure default --token [TOKEN]
+```
+### 5. Deploy on Beam
+```shell
+beam deploy app.py:server
+```
+### 6. Call the stream endpoint
+```shell
+curl -X POST 'https://[ID].app.beam.cloud/stream' \
+-H 'Connection: keep-alive' \
+-H 'Content-Type: application/json' \
+-H 'Authorization: Bearer [TOKEN]' \
+-d '{"prompt": "", "posts_count": 5}'
+```

app.py

@@ -85,6 +85,7 @@ def stream(model: PreTrainedModel, tokenizer: PreTrainedTokenizerFast, body: Bod
 
 
 @asgi(
+    name="jvcgpt",
     on_start=load_models,
     cpu=2.0,
     memory="16Gi",

requirements.txt

@@ -0,0 +1,84 @@
+annotated-types==0.7.0
+anyio==4.8.0
+asgiref==3.8.1
+bcrypt==4.2.1
+beam-client==0.2.132
+beta9==0.1.155
+betterproto-beta9==2.0.0b7
+black==24.10.0
+certifi==2024.12.14
+cffi==1.17.1
+charset-normalizer==3.4.1
+click==8.1.8
+cloudpickle==3.1.1
+croniter==3.0.4
+cryptography==44.0.0
+fastapi==0.110.3
+filelock==3.17.0
+fsspec==2024.12.0
+grpcio==1.69.0
+grpclib==0.4.7
+h11==0.14.0
+h2==4.1.0
+hpack==4.1.0
+huggingface-hub==0.27.1
+hyperframe==6.1.0
+idna==3.10
+isort==5.13.2
+Jinja2==3.1.5
+markdown-it-py==3.0.0
+MarkupSafe==3.0.2
+mdurl==0.1.2
+mpmath==1.3.0
+multidict==6.1.0
+mypy-extensions==1.0.0
+networkx==3.4.2
+numpy==2.2.2
+nvidia-cublas-cu12==12.4.5.8
+nvidia-cuda-cupti-cu12==12.4.127
+nvidia-cuda-nvrtc-cu12==12.4.127
+nvidia-cuda-runtime-cu12==12.4.127
+nvidia-cudnn-cu12==9.1.0.70
+nvidia-cufft-cu12==11.2.1.3
+nvidia-curand-cu12==10.3.5.147
+nvidia-cusolver-cu12==11.6.1.9
+nvidia-cusparse-cu12==12.3.1.170
+nvidia-nccl-cu12==2.21.5
+nvidia-nvjitlink-cu12==12.4.127
+nvidia-nvtx-cu12==12.4.127
+packaging==24.2
+paramiko==3.5.0
+pathspec==0.12.1
+platformdirs==4.3.6
+prompt_toolkit==3.0.50
+protobuf==4.25.6
+pycparser==2.22
+pydantic==2.10.6
+pydantic_core==2.27.2
+Pygments==2.19.1
+PyNaCl==1.5.0
+python-dateutil==2.9.0.post0
+pytz==2024.2
+PyYAML==6.0.2
+regex==2024.11.6
+requests==2.32.3
+rich==13.9.4
+safetensors==0.5.2
+setuptools==75.8.0
+six==1.17.0
+sniffio==1.3.1
+starlette==0.37.2
+sympy==1.13.1
+tokenizers==0.21.0
+torch==2.5.1
+tqdm==4.67.1
+transformers==4.48.1
+triton==3.1.0
+typeguard==2.13.3
+typing_extensions==4.12.2
+urllib3==2.3.0
+uvicorn==0.29.0
+watchdog==4.0.2
+wcwidth==0.2.13
+websocket-client==1.8.0
+websockets==12.0