Update Notes on using Lem's algorithm interface authored by Peter Menegay's avatar Peter Menegay
......@@ -271,7 +271,5 @@ For the trust-weighted histogram algorithm the `intermediate_results` are really
The method by which we update `intermediate_results` here could be improved by doing it automatically, within the calculation. We refrained from that, however, in recognition that doing so is the province of the server code, the one responsible for understanding the tree's overall configuration and how results should pass between the nodes.
Also the `intermediate_results` are really for the parent components of each sub-group. This just happens to be the first component passed to AlgorithmInput in the cases above but there is no mechanism to enforce that. We could, of course, have just set all the components' `intermediate_results` to be the same as that of the parent component and things would have worked. But this seems like a shortcut that might inadvertently cause problems later and be hard to detect. It seems like a better practice to set variables explicitly at the point where we know we will need them for a subsequent calculation.
Also the `intermediate_results` are really for the parent components of each sub-group. This just happens to be the first component passed to AlgorithmInput in the cases above but there is no mechanism to enforce that. We could, of course, have just set all the components' `intermediate_results` to be the same as that of the parent component and things would have worked. But this seems like a shortcut that might inadvertently cause problems later and be hard to detect. It appears a better practice is to set variables explicitly at the point where we know we will need them for a subsequent calculation.