Skip to content

Commit 7d827b9

Browse files
strickvlclaude
andauthored
Add config requirements and environment variables (and fix broken links!) (#238)
* Sync config requirements with updated requirements.txt Remove openai dependency and add missing dependencies (zenml, exa-py, requests, anthropic) to match the updated requirements.txt file across all config files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Add environment variables to config files and update README - Add docker environment variable placeholders to all config files for OPENROUTER_API_KEY, TAVILY_API_KEY, EXA_API_KEY, ANTHROPIC_API_KEY, and Langfuse credentials - Add cloud orchestrator configuration section to README explaining how to replace placeholder values with actual API keys for cloud deployments - Include security recommendation to use cloud provider secret management services 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Fix typo * Fix broken links * Replace hardcoded API key placeholders with environment variable substitution - Update all config files to use ${VARIABLE_NAME} syntax instead of "YOUR_VARIABLE_NAME" placeholders - Update README to reflect automatic environment variable pickup - Users no longer need to manually edit config files for cloud deployment 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Remove redundant zenml requirement from config files ZenML is the orchestration framework already running the pipeline, so it doesn't need to be installed as a dependency inside Docker containers. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent dc4efbe commit 7d827b9

File tree

34 files changed

+164
-76
lines changed

34 files changed

+164
-76
lines changed

credit-scorer/docs/guides/cloud_deployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ☁️ Cloud Deployment
22

3-
CreditScorer supports storing artifacts remotely and executing pipelines on cloud infrastructure. For this example, we'll use AWS, but you can use any cloud provider you want. You can also refer to the [AWS Integration Guide](https://docs.zenml.io/how-to/popular-integrations/aws-guide) for detailed instructions.
3+
CreditScorer supports storing artifacts remotely and executing pipelines on cloud infrastructure. For this example, we'll use AWS, but you can use any cloud provider you want. You can also refer to the [AWS Integration Guide](https://docs.zenml.io/stacks/popular-stacks/aws-guide) for detailed instructions.
44

55
### AWS Setup
66

@@ -75,6 +75,6 @@ Similar setup processes can be followed for other cloud providers:
7575

7676
For detailed configuration options for these providers, refer to the ZenML documentation:
7777

78-
- [GCP Integration Guide](https://docs.zenml.io/how-to/popular-integrations/gcp-guide)
79-
- [Azure Integration Guide](https://docs.zenml.io/how-to/popular-integrations/azure-guide)
80-
- [Kubernetes Integration Guide](https://docs.zenml.io/how-to/popular-integrations/kubernetes)
78+
- [GCP Integration Guide](https://docs.zenml.io/stacks/popular-stacks/gcp-guide)
79+
- [Azure Integration Guide](https://docs.zenml.io/stacks/popular-stacks/azure-guide)
80+
- [Kubernetes Integration Guide](https://docs.zenml.io/stacks/popular-stacks/kubernetes)

databricks-production-qa-demo/steps/deployment/deployment_deploy.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def deployment_deploy() -> Annotated[
4545
In this example, the step can be configured to use different input data.
4646
See the documentation for more information:
4747
48-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
48+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
4949
5050
Args:
5151
dataset_inf: The inference dataset.

databricks-production-qa-demo/steps/etl/data_loader.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def data_loader(
4444
In this example, the step can be configured with number of rows and logic
4545
to drop target column or not. See the documentation for more information:
4646
47-
https://docs.zenml.io/how-to/build-pipelines/use-pipeline-step-parameters
47+
https://docs.zenml.io/concepts/steps_and_pipelines#pipeline-parameterization
4848
4949
Args:
5050
is_inference: If `True` subset will be returned and target column

databricks-production-qa-demo/steps/etl/train_data_preprocessor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def train_data_preprocessor(
5252
columns and normalize numerical columns. See the documentation for more
5353
information:
5454
55-
https://docs.zenml.io/how-to/build-pipelines/use-pipeline-step-parameters
55+
https://docs.zenml.io/concepts/steps_and_pipelines#pipeline-parameterization
5656
5757
Args:
5858
dataset_trn: The train dataset.

databricks-production-qa-demo/steps/etl/train_data_splitter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def train_data_splitter(
4141
In this example, the step can be configured to use different test
4242
set sizes. See the documentation for more information:
4343
44-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
44+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
4545
4646
Args:
4747
dataset: Dataset read from source.

databricks-production-qa-demo/steps/hp_tuning/hp_tuning_single_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ def hp_tuning_single_search(
5050
to use different input datasets and also have a flag to fall back to default
5151
model architecture. See the documentation for more information:
5252
53-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
53+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
5454
5555
Args:
5656
model_package: The package containing the model to use for hyperparameter tuning.

databricks-production-qa-demo/steps/inference/inference_predict.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def inference_predict(
4343
In this example, the step can be configured to use different input data.
4444
See the documentation for more information:
4545
46-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
46+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
4747
4848
Args:
4949
dataset_inf: The inference dataset.

databricks-production-qa-demo/steps/promotion/compute_performance_metrics_on_current_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def compute_performance_metrics_on_current_data(
4444
and target environment stage for promotion.
4545
See the documentation for more information:
4646
47-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
47+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
4848
4949
Args:
5050
dataset_tst: The test dataset.

databricks-production-qa-demo/steps/promotion/promote_with_metric_compare.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def promote_with_metric_compare(
4646
and target environment stage for promotion.
4747
See the documentation for more information:
4848
49-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
49+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
5050
5151
Args:
5252
latest_metric: Recently trained model metric results.

databricks-production-qa-demo/steps/training/model_trainer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def model_trainer(
7272
hyperparameters to the model constructor. See the documentation for more
7373
information:
7474
75-
https://docs.zenml.io/how-to/pipeline-development/use-configuration-files
75+
https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration
7676
7777
Args:
7878
dataset_trn: The preprocessed train dataset.

0 commit comments

Comments
 (0)