Skip to content

Commit 6d2fbcb

Browse files
PatrickPatrick
authored andcommitted
Fixes file name and some typos
1 parent 5b82d09 commit 6d2fbcb

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This python package can also be used to create a serverless worker that can be d
5050

5151
### Quick Start
5252

53-
Create an python script in your project that contains your model definition and the RunPod worker start code. Run this python code as your default container start command:
53+
Create a python script in your project that contains your model definition and the RunPod worker start code. Run this python code as your default container start command:
5454

5555
```python
5656
# my_worker.py
@@ -73,7 +73,7 @@ def is_even(job):
7373
runpod.serverless.start({"handler": is_even})
7474
```
7575

76-
Make sure that this file is ran when your container starts. This can be accomplished by calling it in the docker command when you setup a template at [runpod.io/console/serverless/user/templates](https://www.runpod.io/console/serverless/user/templates) or by setting it as the default command in your Dockerfile.
76+
Make sure that this file is ran when your container starts. This can be accomplished by calling it in the docker command when you set up a template at [runpod.io/console/serverless/user/templates](https://www.runpod.io/console/serverless/user/templates) or by setting it as the default command in your Dockerfile.
7777

7878
See our [blog post](https://www.runpod.io/blog/serverless-create-a-basic-api) for creating a basic Serverless API, or view the [details docs](https://docs.runpod.io/serverless-ai/custom-apis) for more information.
7979

File renamed without changes.

docs/cli/references/projects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Projects
22

3-
A runpod project is a single folder that contains all the files needed to create and run a serverless worker.
3+
A RunPod project is a single folder that contains all the files needed to create and run a serverless worker.
44

55
## Convert existing worker to a project
66

@@ -10,4 +10,4 @@ You may need to update the default configuration within `runpod.toml` to match y
1010

1111
## Ignore Files and Folders
1212

13-
Create a `.runpodignore` file in the root of your project to ignore files and folders from being uploaded to the runpod platform, the same file will also be used to ignore files that should not trigger a API server reload.
13+
Create a `.runpodignore` file in the root of your project to ignore files and folders from being uploaded to the RunPod platform, the same file will also be used to ignore files that should not trigger an API server reload.

docs/cli/references/runpod.toml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project File
22

3-
Project files are stored as a `runpod.toml` file in the root of your project. This file contains all the information needed to run your project on the runpod platform.
3+
Project files are stored as a `runpod.toml` file in the root of your project. This file contains all the information needed to run your project on the RunPod platform.
44

55
## Example
66

docs/getting_Started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
The runpod python library is a powerful library providing SDK functions, API access, and CLI commands for interacting with the runpod platform.
3+
The RunPod python library is a powerful library providing SDK functions, API access, and CLI commands for interacting with the RunPod platform.
44

55
## Credentials File
66

@@ -12,7 +12,7 @@ api_key = "YOUR_RUNPOD_API_KEY"
1212
```
1313
### Profile
1414

15-
By default all credentials are stored under the `default` profile. To switch profiles you can use the `--profile` argument on CLI commands or change the profile within a script.
15+
By default, all credentials are stored under the `default` profile. To switch profiles you can use the `--profile` argument on CLI commands or change the profile within a script.
1616

1717
```python
1818
import runpod

docs/serverless/local_testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
It is important to test your serverless workers locally before deploying them to the cloud. This will help you catch errors early and avoid wasting cloud resources. This guide will show you how to test your serverless workers locally.
44

5-
If any errors are returned by the worker while running a test_input job the worker will exit with a non-zero exit code. Otherwise the worker will exit with a zero exit code. This can be used to check if the worker ran successfully, for example in a CI/CD pipeline.
5+
If any errors are returned by the worker while running a test_input job the worker will exit with a non-zero exit code. Otherwise, the worker will exit with a zero exit code. This can be used to check if the worker ran successfully, for example in a CI/CD pipeline.
66

77
## Test Input File
88

docs/serverless/worker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `config` parameter is a dictionary containing the following keys:
2424

2525
### handler
2626

27-
The handler function can either had a standard return or be a generator function. If the handler is a generator function, it will be called with the job input and the generator will be iterated over until it is exhausted.
27+
The handler function can either have a standard return or be a generator function. If the handler is a generator function, it will be called with the job input and the generator will be iterated over until it is exhausted.
2828

2929
## Worker Refresh
3030

0 commit comments

Comments
 (0)