alihan/tokencost
1
0
Fork 0
mirror of https://github.com/AgentOps-AI/tokencost.git synced 2024-06-22 04:30:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

byebye readme

Browse Source
This commit is contained in:
trisha
2023-12-08 15:33:29 -06:00
parent 7560038c6c
commit 77c0302062
1 changed files with 6 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@@ -1,56 +1,11 @@
# TokenCost
# Token Cost
## Overview
One Paragraph of project description goes here
TokenCost is a specialized tool designed for calculating the token count and associated cost of strings and messages used in Large Language Models (LLMs). This utility is particularly useful for developers and researchers working with language models, enabling them to estimate the computational resources required for processing various inputs.
## Getting Started
## Features
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- **Token Counting**: Accurately counts the number of tokens in a given string or message.
- **Cost Calculation**: Computes the cost of processing based on the token count, considering the specific pricing model of the LLM in use.
- **Support for Multiple LLMs**: Compatible with various Large Language Models.
- **Easy Integration**: Simple API for integrating with existing projects or workflows.
### Prerequisites
## Installation
To install TokenCost, use the following command:
```bash
git clone https://github.com/yourusername/tokencost.git
cd tokencost
pip install -r requirements.txt
```
## Usage
To use TokenCost, follow these steps:
1. Import the module:
```python
from tokencost import TokenCalculator
```
3. Calculate tokens and cost:
```python
text = "Your sample text here"
token_count, cost = calculator.calculate(text)
print(f"Token Count: {token_count}, Cost: {cost}")
```
To run tests, follow the below steps:
0. `pip install pytest` if you don't have pytest already
1. `pytest tests` while in the `tokencost` folder to run the `tests` folder
## Contributing
Contributions to TokenCost are welcome! Please refer to our Contribution Guidelines for more details.
## License
TokenCost is released under the MIT License.
What things you need to install the software and how to install them