Skip to content

Commit 45fbc66

Browse files
authored
Readme cpu-size fix (#39)
1 parent 6c69289 commit 45fbc66

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,23 @@ datacustomcode run ./payload/entrypoint.py
7070
7171
After modifying the `entrypoint.py` as needed, using any dependencies you add in the `.venv` virtual environment, you can run this script in Data Cloud:
7272

73-
**Adding Dependencies**: To add new dependencies:
73+
**To Add New Dependencies**:
7474
1. Make sure your virtual environment is activated
7575
2. Add dependencies to `requirements.txt`
7676
3. Run `pip install -r requirements.txt`
7777
4. The SDK automatically packages all dependencies when you run `datacustomcode zip`
7878

7979
```zsh
8080
datacustomcode scan ./payload/entrypoint.py
81-
datacustomcode deploy --path ./payload --name my_custom_script --compute-type CPU_L
81+
datacustomcode deploy --path ./payload --name my_custom_script --cpu-size CPU_L
8282
```
8383

8484
> [!TIP]
8585
> The `deploy` process can take several minutes. If you'd like more feedback on the underlying process, you can add `--debug` to the command like `datacustomcode --debug deploy --path ./payload --name my_custom_script`
86-
>
86+
8787
> [!NOTE]
88-
> **Compute Types**: Choose the appropriate compute type based on your workload requirements:
89-
> - **CPU_L/CPU_XL/CPU_2XL/CPU_4XL**: Large, X-Large, 2X-Large and 4X-Large CPU instances for data processing
88+
> **CPU Size**: Choose the appropriate CPU/Compute Size based on your workload requirements:
89+
> - **CPU_L / CPU_XL / CPU_2XL / CPU_4XL**: Large, X-Large, 2X-Large and 4X-Large CPU instances for data processing
9090
> - Default is `CPU_2XL` which provides a good balance of performance and cost for most use cases
9191
9292
You can now use the Salesforce Data Cloud UI to find the created Data Transform and use the `Run Now` button to run it.
@@ -154,23 +154,14 @@ Options:
154154
- `--client-secret TEXT`: Connected App Client Secret
155155
- `--login-url TEXT`: Salesforce login URL
156156

157-
#### `datacustomcode deploy`
158-
Deploy a transformation job to Data Cloud.
159-
160-
Options:
161-
- `--profile TEXT`: Credential profile name (default: "default")
162-
- `--path TEXT`: Path to the code directory (default: ".")
163-
- `--name TEXT`: Name of the transformation job [required]
164-
- `--version TEXT`: Version of the transformation job (default: "0.0.1")
165-
- `--description TEXT`: Description of the transformation job (default: "")
166-
- `--compute-type TEXT`: Compute type for the deployment (default: "CPU_XL"). Available options: CPU_L(Large), CPU_XL (Extra Large), CPU_2XL (2X Large), CPU_4XL (4X Large)
167157

168158
#### `datacustomcode init`
169159
Initialize a new development environment with a template.
170160

171161
Argument:
172162
- `DIRECTORY`: Directory to create project in (default: ".")
173163

164+
174165
#### `datacustomcode scan`
175166
Scan a Python file to generate a Data Cloud configuration.
176167

@@ -181,6 +172,7 @@ Options:
181172
- `--config TEXT`: Path to save the configuration file (default: same directory as FILENAME)
182173
- `--dry-run`: Preview the configuration without saving to a file
183174

175+
184176
#### `datacustomcode run`
185177
Run an entrypoint file locally for testing.
186178

@@ -191,12 +183,26 @@ Options:
191183
- `--config-file TEXT`: Path to configuration file
192184
- `--dependencies TEXT`: Additional dependencies (can be specified multiple times)
193185

186+
194187
#### `datacustomcode zip`
195188
Zip a transformation job in preparation to upload to Data Cloud.
196189

197190
Options:
198191
- `--path TEXT`: Path to the code directory (default: ".")
199192

193+
194+
#### `datacustomcode deploy`
195+
Deploy a transformation job to Data Cloud.
196+
197+
Options:
198+
- `--profile TEXT`: Credential profile name (default: "default")
199+
- `--path TEXT`: Path to the code directory (default: ".")
200+
- `--name TEXT`: Name of the transformation job [required]
201+
- `--version TEXT`: Version of the transformation job (default: "0.0.1")
202+
- `--description TEXT`: Description of the transformation job (default: "")
203+
- `--cpu-size TEXT`: CPU size for the deployment (default: "CPU_XL"). Available options: CPU_L(Large), CPU_XL(Extra Large), CPU_2XL(2X Large), CPU_4XL(4X Large)
204+
205+
200206
## Docker usage
201207

202208
The SDK provides Docker-based development options that allow you to test your code in an environment that closely resembles Data Cloud's execution environment.
@@ -274,4 +280,5 @@ You now have all fields necessary for the `datacustomcode configure` command.
274280

275281
## Other docs
276282

277-
[Troubleshooting](./docs/troubleshooting.md)
283+
- [Troubleshooting](./docs/troubleshooting.md)
284+
- [For Contributors](./FOR_CONTRIBUTORS.md)

0 commit comments

Comments
 (0)