Skip to content

Commit 6cfcea3

Browse files
authored
add example projects/blogs (#573)
1 parent 8bd4e7b commit 6cfcea3

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,11 @@ terraform destroy
139139

140140
This terminates the `machine` (if still running), downloads `output`, and removes the persistent `disk_size` storage.
141141

142+
## Example Projects
143+
144+
- [Run Jupyter & TensorBoard in the cloud with one command](https://github.com/iterative/blog-tpi-jupyter)
145+
- [Move local ML experiments to the cloud](https://github.com/iterative/blog-tpi-bees)
146+
142147
## How it Works
143148

144149
This diagram may help to see what TPI does under-the-hood:
@@ -175,7 +180,7 @@ style C fill:#7B61FF,stroke:#333333,color:#000000
175180

176181
## Future Plans
177182

178-
TPI is a CLI tool bringing the power of bare-metal cloud to a bare-metal local laptop. We're working on more featureful and visual interfaces. We'd also like to have more native support for distributed (multi-instance) training, more data sync optimisations & options, and tighter ecosystem integration with tools such as [DVC](https://dvc.org).
183+
TPI is a CLI tool bringing the power of bare-metal cloud to a bare-metal local laptop. We're working on more featureful and visual interfaces. We'd also like to have more native support for distributed (multi-instance) training, more data sync optimisations & options, and tighter ecosystem integration with tools such as [DVC](https://dvc.org). Plus of course more examples for Data Scientists and Machine Learning Engineers - from Jupyter, VSCode, and Codespaces to improving the live logging/monitoring/reporting experience.
179184

180185
## Help
181186

docs/guides/authentication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ terraform apply
2222

2323
See the [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) to obtain these variables directly.
2424

25-
Alternatively, for more idiomatic or advanced use cases, follow the [Terraform AWS provider documentation](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) and run the following commands in the [`permissions/aws`](https://github.com/iterative/terraform-provider-iterative/tree/master/docs/guides/permissions/aws) directory:
25+
Alternatively, for more idiomatic or advanced use cases, follow the [Terraform AWS provider documentation](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) and run the following commands in the [permissions/aws](https://github.com/iterative/terraform-provider-iterative/tree/master/docs/guides/permissions/aws) directory:
2626

2727
```bash
2828
terraform init && terraform apply
@@ -41,7 +41,7 @@ export AWS_SECRET_ACCESS_KEY="$(terraform output --raw aws_secret_access_key)"
4141

4242
See the [Azure documentation](https://docs.microsoft.com/en-us/python/api/azure-identity/azure.identity.environmentcredential) to obtain these variables directly.
4343

44-
Alternatively, for more idiomatic or advanced use cases, follow the [Terraform Azure provider documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/azure_cli) and run the following commands in the [`permissions/az`](https://github.com/iterative/terraform-provider-iterative/tree/master/docs/guides/permissions/az) directory:
44+
Alternatively, for more idiomatic or advanced use cases, follow the [Terraform Azure provider documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/azure_cli) and run the following commands in the [permissions/az](https://github.com/iterative/terraform-provider-iterative/tree/master/docs/guides/permissions/az) directory:
4545

4646
```bash
4747
terraform init && terraform apply
@@ -60,7 +60,7 @@ export AZURE_CLIENT_SECRET="$(terraform output --raw azure_client_secret)"
6060

6161
See the [GCP documentation](https://cloud.google.com/docs/authentication/getting-started#creating_a_service_account) to obtain these variables directly.
6262

63-
Alternatively, for more idiomatic or advanced use cases, follow the [Terraform GCP provider documentation](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started) and run the following commands in the [`permissions/gcp`](https://github.com/iterative/terraform-provider-iterative/tree/master/docs/guides/permissions/gcp) directory:
63+
Alternatively, for more idiomatic or advanced use cases, follow the [Terraform GCP provider documentation](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started) and run the following commands in the [permissions/gcp](https://github.com/iterative/terraform-provider-iterative/tree/master/docs/guides/permissions/gcp) directory:
6464

6565
```bash
6666
terraform init && terraform apply

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,6 @@ There are a several reasons to use TPI instead of other related solutions (custo
4747
- [Getting Started](https://registry.terraform.io/providers/iterative/iterative/latest/docs/guides/getting-started)
4848
- [Authentication][auth]
4949
- [Full reference](https://registry.terraform.io/providers/iterative/iterative/latest/docs/resources/task)
50+
- Example Projects
51+
- [Run Jupyter & TensorBoard in the cloud with one command](https://github.com/iterative/blog-tpi-jupyter)
52+
- [Move local ML experiments to the cloud](https://github.com/iterative/blog-tpi-bees)

0 commit comments

Comments
 (0)