diff --git a/README.md b/README.md index a9342b4..9aa6850 100644 --- a/README.md +++ b/README.md @@ -65,18 +65,12 @@ s3Client.make_bucket('mlflow') 5. Configure your client-side -For running mlflow files you AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables present on the client-side. +For running mlflow files you need various environment variables set on the client side. To generate them user the convienience script `./bashrc_install.sh`, which installs it on your system or `./bashrc_generate.sh`, which just displays the config to copy & paste. -Also, you will need to specify the address of your S3 server (minio) and mlflow tracking server. For that, run following script +> $ ./bashrc_install.sh +> [ OK ] Successfully installed environment variables into your .bashrc! -```shell -export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE -export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -export MLFLOW_S3_ENDPOINT_URL=http://localhost:9000 -export MLFLOW_TRACKING_URI=http://localhost:5000 -``` - -or paste it into your .bashrc file and then run `source ~/.bashrc` +The script installs this variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, MLFLOW_S3_ENDPOINT_URL, MLFLOW_TRACKING_URI. All of them are needed to use mlflow from the client-side. 6. Test the pipeline with below command with conda. If you dont have conda installed run with `--no-conda` diff --git a/bashrc_generate.sh b/bashrc_generate.sh new file mode 100644 index 0000000..d64da98 --- /dev/null +++ b/bashrc_generate.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +source .env + +echo "Copy and paste below configuration into your ~/.bashrc file!" +echo "" +echo "# MLFLOW CONFIG" +echo "export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID" +echo "export AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY" +echo "export MLFLOW_S3_ENDPOINT_URL=$MLFLOW_S3_ENDPOINT_URL" +echo "export MLFLOW_TRACKING_URI=$MLFLOW_TRACKING_URI" +echo "# END MLFLOW CONFIG" \ No newline at end of file diff --git a/bashrc_install.sh b/bashrc_install.sh new file mode 100644 index 0000000..3b777ad --- /dev/null +++ b/bashrc_install.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +source .env + +echo "# MLFLOW CONFIG" >> ~/.bashrc +echo "export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID" >> ~/.bashrc +echo "export AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY" >> ~/.bashrc +echo "export MLFLOW_S3_ENDPOINT_URL=$MLFLOW_S3_ENDPOINT_URL" >> ~/.bashrc +echo "export MLFLOW_TRACKING_URI=$MLFLOW_TRACKING_URI" >> ~/.bashrc +echo "# END MLFLOW CONFIG" >> ~/.bashrc + +echo "[ OK ] Successfully installed environment variables into your .bashrc!" \ No newline at end of file