Various small docs clarifications #20
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryandawsonuk
commented
May 26, 2022
| @@ -18,7 +18,7 @@ Enter your Github Personal Access Token. | |||
|
|
|||
| Select your github account, then cd4ml-scenarios and click "Create Pipeline" | |||
|
|
|||
| At this step the pipeline will build, you can select the pipeline to see the individual steps execute. At the end the pipeline should be 'green' indicating that all the steps were successful (shown below). | |||
| At this step the pipeline will build, you can select the pipeline to see the individual steps execute. Jenkins will first index branches, [which can take time](https://support.cloudbees.com/hc/en-us/articles/360055870591-Multibranch-Pipeline-Branch-indexing-job-stuck-and-cannot-be-aborted). It will then checkout the code which [can also take a while](https://stackoverflow.com/questions/36017253/jenkins-git-fetch-timeout). It does get there eventually. At the end the pipeline should run and be 'green' indicating that all the steps were successful (shown below). If it times out then trigger a manual run. | |||
There was a problem hiding this comment.
This is basically reporting my experience with docker desktop. FWIW I was testing before f4e6e02 but I suspect this is something that can come and go depending on network connection and github itself
ryandawsonuk
commented
May 26, 2022
| @@ -35,7 +35,7 @@ being changed to something else. | |||
|
|
|||
| Note in the lasso directory, there is a file called big_alpha.json which | |||
| corresponds to the 'big_alpha' that we typed into that text box. It has | |||
| an alpha parameter of 50 rather than 1 and so encourages sparseness | |||
| an alpha parameter of 50 rather than 1 and so [encourages sparseness](https://chrisalbon.com/code/machine_learning/linear_regression/effect_of_alpha_on_lasso_regression/) | |||
There was a problem hiding this comment.
extra link offers clarification
ryandawsonuk
commented
May 26, 2022
|
|
||
|
|
||
| 6) Looks at the ml_pipeline_params directory. Similarly, it contains a default.json file. | ||
| 6) Look at the ml_pipeline directory. Similarly, it contains a default.json file. |
There was a problem hiding this comment.
There is no ml_pipeline_params directory, it means ml_pipeline
ryandawsonuk
commented
May 26, 2022
|
|
||
|  | ||
|
|
||
| This lets us use Jenkins like an [ML training orchestration platform](https://github.com/EthicalML/awesome-production-machine-learning#model-training-orchestration). | ||
|
|
There was a problem hiding this comment.
This note helps to clarify that our use of Jenkins here is just an example/illustration
|
Looks great. Thanks for the update @ryandawsonuk ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Points that I noticed when running through this and which I felt would've made it clearer for me