Skip to content

Commit 0bc2c97

Browse files
committed
Updated Github URLs
1 parent 88735df commit 0bc2c97

File tree

12 files changed

+63
-37
lines changed

12 files changed

+63
-37
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# 🚀 LocalLab: Run AI Models Easily
22

3-
[![Build Status](https://img.shields.io/github/actions/workflow/status/Developer-Utkarsh/LocalLab/publish.yml?style=flat-square)](https://github.com/Developer-Utkarsh/LocalLab/actions)
3+
[![Build Status](https://img.shields.io/github/actions/workflow/status/UtkarshTheDev/LocalLab/publish.yml?style=flat-square)](https://github.com/UtkarshTheDev/LocalLab/actions)
44
[![LocalLab Version](https://img.shields.io/pypi/v/locallab.svg?style=flat-square)](https://pypi.org/project/locallab/)
55
[![Python Version](https://img.shields.io/pypi/pyversions/locallab.svg?style=flat-square)](https://pypi.org/project/locallab/)
6-
[![License](https://img.shields.io/github/license/Developer-Utkarsh/LocalLab.svg?style=flat-square)](https://github.com/Developer-Utkarsh/LocalLab/blob/main/LICENSE)
6+
[![License](https://img.shields.io/github/license/UtkarshTheDev/LocalLab.svg?style=flat-square)](https://github.com/UtkarshTheDev/LocalLab/blob/main/LICENSE)
77

88
LocalLab empowers users to run any Hugging Face AI model locally or on Google Colab with minimal setup required. It automatically configures an API using ngrok, enabling seamless integration into applications from any location. Designed for simplicity, LocalLab makes advanced AI accessible to all, regardless of technical expertise. With built-in model management, performance optimizations, and system monitoring, it ensures efficient and reliable AI operations for developers, researchers, and enthusiasts alike.
99

@@ -78,15 +78,15 @@ sequenceDiagram
7878

7979
## Documentation & Usage Guides
8080

81-
For full documentation and detailed guides, please visit our [documentation page](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/README.md).
81+
For full documentation and detailed guides, please visit our [documentation page](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/README.md).
8282

83-
- [Getting Started Guide](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/guides/getting-started.md)
84-
- [CLI Guide](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/guides/cli.md)
85-
- [Python Client](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/clients/python/README.md)
86-
- [Node.js Client](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/clients/nodejs/README.md)
87-
- [Client Comparison](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/clients/comparison.md)
88-
- [Google Colab Guide](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/colab/README.md)
89-
- [API Reference](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/guides/api.md)
83+
- [Getting Started Guide](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/guides/getting-started.md)
84+
- [CLI Guide](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/guides/cli.md)
85+
- [Python Client](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/clients/python/README.md)
86+
- [Node.js Client](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/clients/nodejs/README.md)
87+
- [Client Comparison](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/clients/comparison.md)
88+
- [Google Colab Guide](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/colab/README.md)
89+
- [API Reference](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/guides/api.md)
9090

9191
## Get Started
9292

@@ -180,9 +180,9 @@ locallab info
180180

181181
## Join the Community
182182

183-
- Report issues on our [GitHub Issues](https://github.com/Developer-Utkarsh/LocalLab/issues).
184-
- Participate in discussions on our [Community Forum](https://github.com/Developer-Utkarsh/LocalLab/discussions).
185-
- Learn how to contribute by reading our [Contributing Guidelines](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/guides/contributing.md).
183+
- Report issues on our [GitHub Issues](https://github.com/UtkarshTheDev/LocalLab/issues).
184+
- Participate in discussions on our [Community Forum](https://github.com/UtkarshTheDev/LocalLab/discussions).
185+
- Learn how to contribute by reading our [Contributing Guidelines](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/guides/contributing.md).
186186

187187
---
188188

client/python_client/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ dev = [
4242
]
4343

4444
[project.urls]
45-
Homepage = "https://github.com/Developer-Utkarsh/LocalLab"
46-
Documentation = "https://github.com/Developer-Utkarsh/LocalLab#readme"
47-
Repository = "https://github.com/Developer-Utkarsh/LocalLab.git"
48-
Issues = "https://github.com/Developer-Utkarsh/LocalLab/issues"
45+
Homepage = "https://github.com/UtkarshTheDev/LocalLab"
46+
Documentation = "https://github.com/UtkarshTheDev/LocalLab#readme"
47+
Repository = "https://github.com/UtkarshTheDev/LocalLab.git"
48+
Issues = "https://github.com/UtkarshTheDev/LocalLab/issues"
4949

5050
[tool.black]
5151
line-length = 100

client/python_client/setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
setup(
77
name="locallab-client",
88
version="1.0.1",
9-
author="Your Name",
9+
author="Utkarsh Tiwari",
1010
author_email="your.email@example.com",
1111
description="Official Python client for LocalLab - A local LLM server",
1212
long_description=long_description,
@@ -50,4 +50,4 @@
5050
"Documentation": "https://github.com/yourusername/locallab-client#readme",
5151
"Source Code": "https://github.com/yourusername/locallab-client",
5252
},
53-
)
53+
)

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ stateDiagram-v2
133133
- Use the navigation above to find specific topics
134134
- Check [FAQ](./guides/faq.md) for quick answers
135135
- Visit [Troubleshooting](./guides/troubleshooting.md) for common issues
136-
- Open an [Issue](https://github.com/Developer-Utkarsh/LocalLab/issues) for support
136+
- Open an [Issue](https://github.com/UtkarshTheDev/LocalLab/issues) for support
137137

138138
## 🌟 Features
139139

@@ -146,8 +146,8 @@ stateDiagram-v2
146146

147147
## 📚 Additional Resources
148148

149-
- [GitHub Repository](https://github.com/Developer-Utkarsh/LocalLab)
150-
- [Community Forum](https://github.com/Developer-Utkarsh/LocalLab/discussions)
149+
- [GitHub Repository](https://github.com/UtkarshTheDev/LocalLab)
150+
- [Community Forum](https://github.com/UtkarshTheDev/LocalLab/discussions)
151151
- [Contributing Guidelines](./guides/contributing.md)
152152

153153
---

docs/colab/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The fastest way to get started is to use our [Interactive Colab Guide](./localla
1010
- System monitoring
1111
- Troubleshooting help
1212

13-
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Developer-Utkarsh/LocalLab/blob/main/docs/colab/locallab_colab_guide.ipynb)
13+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/UtkarshTheDev/LocalLab/blob/main/docs/colab/locallab_colab_guide.ipynb)
1414

1515
## Features Available in Colab
1616

@@ -36,7 +36,7 @@ The fastest way to get started is to use our [Interactive Colab Guide](./localla
3636

3737
- Check our [Troubleshooting Guide](./troubleshooting.md)
3838
- Visit our [FAQ](./faq.md)
39-
- Open an [Issue](https://github.com/Developer-Utkarsh/LocalLab/issues)
39+
- Open an [Issue](https://github.com/UtkarshTheDev/LocalLab/issues)
4040

4141
```mermaid
4242
graph TD

docs/colab/locallab_colab_guide.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -292,9 +292,9 @@
292292
" - Ensure sufficient resources\n",
293293
"\n",
294294
"For more help, visit:\n",
295-
"- [Troubleshooting Guide](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/TROUBLESHOOTING.md)\n",
296-
"- [FAQ](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/FAQ.md)\n",
297-
"- [GitHub Issues](https://github.com/Developer-Utkarsh/LocalLab/issues)"
295+
"- [Troubleshooting Guide](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/TROUBLESHOOTING.md)\n",
296+
"- [FAQ](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/FAQ.md)\n",
297+
"- [GitHub Issues](https://github.com/UtkarshTheDev/LocalLab/issues)"
298298
]
299299
}
300300
],

docs/features/security.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,4 @@ You may also enable compression and other settings to guard against overuse of r
3333
export LOCALLAB_ENABLE_COMPRESSION="true"
3434
```
3535

36-
For more advanced security configurations (such as API key based authentication), please explore further customizations or open an issue on the [LocalLab GitHub repository](https://github.com/Developer-Utkarsh/LocalLab/issues).
37-
36+
For more advanced security configurations (such as API key based authentication), please explore further customizations or open an issue on the [LocalLab GitHub repository](https://github.com/UtkarshTheDev/LocalLab/issues).

docs/guides/api.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
Generate text using the loaded model.
1010

1111
**Request Body:**
12+
1213
```json
1314
{
1415
"prompt": "string",
@@ -21,6 +22,7 @@ Generate text using the loaded model.
2122
```
2223

2324
**Response:**
25+
2426
```json
2527
{
2628
"response": "string",
@@ -33,6 +35,7 @@ Generate text using the loaded model.
3335
```
3436

3537
**Error Responses:**
38+
3639
- `400 Bad Request`: Invalid parameters
3740
- `413 Payload Too Large`: Input too long
3841
- `429 Too Many Requests`: Rate limit exceeded
@@ -45,6 +48,7 @@ Generate text using the loaded model.
4548
Chat completion endpoint similar to OpenAI's API.
4649

4750
**Request Body:**
51+
4852
```json
4953
{
5054
"messages": [
@@ -62,6 +66,7 @@ Chat completion endpoint similar to OpenAI's API.
6266
```
6367

6468
**Response:**
69+
6570
```json
6671
{
6772
"choices": [
@@ -84,54 +89,65 @@ Chat completion endpoint similar to OpenAI's API.
8489
### Model Management
8590

8691
#### POST `/models/load`
92+
8793
Load a specific model.
8894

8995
**Request Body:**
96+
9097
```json
9198
{
9299
"model_id": "string"
93100
}
94101
```
95102

96103
#### GET `/models/current`
104+
97105
Get information about the currently loaded model.
98106

99107
#### GET `/models/available`
108+
100109
List all available models in the registry.
101110

102111
### System Information
103112

104113
#### GET `/system/info`
114+
105115
Get detailed system information.
106116

107117
#### GET `/health`
118+
108119
Check the health status of the server.
109120

110121
## Error Handling
111122

112123
All endpoints return appropriate HTTP status codes:
124+
113125
- `200`: Success
114126
- `400`: Bad Request
115127
- `404`: Not Found
116128
- `500`: Internal Server Error
117129

118130
Error responses include a detail message:
131+
119132
```json
120133
{
121134
"detail": "Error message describing what went wrong"
122135
}
123136
```
124137

125138
## Rate Limiting
139+
126140
- 60 requests per minute
127141
- Burst size of 10 requests
128142

129143
## Related Documentation
144+
130145
- [Getting Started](./getting-started.md)
131146
- [Features Guide](./features/README.md)
132147
- [Local Deployment](./local_deployment.md)
133148
- [Troubleshooting Guide](./TROUBLESHOOTING.md)
134149

135150
---
151+
136152
Made with ❤️ by Utkarsh Tiwari
137-
GitHub: [Developer-Utkarsh](https://github.com/Developer-Utkarsh) | Twitter: [@UtkarshTheDev](https://twitter.com/UtkarshTheDev) | LinkedIn: [utkarshthedev](https://linkedin.com/in/utkarshthedev)
153+
GitHub: [UtkarshTheDev](https://github.com/UtkarshTheDev) | Twitter: [@UtkarshTheDev](https://twitter.com/UtkarshTheDev) | LinkedIn: [utkarshthedev](https://linkedin.com/in/utkarshthedev)

docs/guides/contributing.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,19 @@
1313
## Getting Started
1414

1515
1. **Fork the Repository**
16-
- Visit [LocalLab on GitHub](https://github.com/Developer-Utkarsh/LocalLab)
16+
17+
- Visit [LocalLab on GitHub](https://github.com/UtkarshTheDev/LocalLab)
1718
- Click the "Fork" button
1819

1920
2. **Clone Your Fork**
21+
2022
```bash
2123
git clone https://github.com/your-username/LocalLab.git
2224
cd LocalLab
2325
```
2426

2527
3. **Set Up Development Environment**
28+
2629
```bash
2730
# Create virtual environment
2831
python -m venv venv
@@ -49,13 +52,15 @@ pre-commit install
4952
## Code Style
5053

5154
We follow these guidelines:
55+
5256
- PEP 8 for Python code style
5357
- Type hints for function arguments and returns
5458
- Docstrings for all public functions
5559
- Comments for complex logic
5660
- Maximum line length of 100 characters
5761

5862
Example:
63+
5964
```python
6065
from typing import List, Optional
6166

@@ -81,16 +86,19 @@ def process_text(
8186
## Making Changes
8287

8388
1. **Create a Branch**
89+
8490
```bash
8591
git checkout -b feature/your-feature-name
8692
```
8793

8894
2. **Make Your Changes**
95+
8996
- Follow code style guidelines
9097
- Add tests for new features
9198
- Update documentation
9299

93100
3. **Run Tests**
101+
94102
```bash
95103
# Run all tests
96104
pytest
@@ -142,6 +150,7 @@ pytest --cov=locallab --cov-report=html
142150
- Update relevant documentation files
143151

144152
Example:
153+
145154
```python
146155
class ModelManager:
147156
"""Manages AI model loading and inference.
@@ -171,24 +180,26 @@ make html
171180
## Submitting Changes
172181

173182
1. **Commit Your Changes**
183+
174184
```bash
175185
git add .
176186
git commit -m "feat: add new feature"
177187
```
178188

179189
2. **Push to Your Fork**
190+
180191
```bash
181192
git push origin feature/your-feature-name
182193
```
183194

184195
3. **Create Pull Request**
185-
- Go to the [LocalLab repository](https://github.com/Developer-Utkarsh/LocalLab)
196+
- Go to the [LocalLab repository](https://github.com/UtkarshTheDev/LocalLab)
186197
- Click "New Pull Request"
187198
- Select your branch
188199
- Fill in the PR template
189200

190201
## Need Help?
191202

192-
- Check our [Troubleshooting Guide](https://github.com/Developer-Utkarsh/LocalLab/blob/main/docs/troubleshooting.md)
203+
- Check our [Troubleshooting Guide](https://github.com/UtkarshTheDev/LocalLab/blob/main/docs/troubleshooting.md)
193204
- Join our [Discord Community](https://discord.gg/locallab)
194-
- Open an [Issue](https://github.com/Developer-Utkarsh/LocalLab/issues)
205+
- Open an [Issue](https://github.com/UtkarshTheDev/LocalLab/issues)

docs/guides/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,4 +153,4 @@ responses = await client.batch_generate([
153153

154154
- See [FAQ](./faq.md)
155155
- Visit [Troubleshooting](./troubleshooting.md)
156-
- Join our [Community](https://github.com/Developer-Utkarsh/LocalLab/discussions)
156+
- Join our [Community](https://github.com/UtkarshTheDev/LocalLab/discussions)

0 commit comments

Comments
 (0)