In a folder called 'examples', we need 3 or 4 notebooks which showcase the different functionality of the product and also serve as training material.
They should be based on real-world scenarios, and tackle real world problems.
For each, add a markdown header explaining the purpose, then a prerequisite installation command. Break it into cells for easy reading and each should be documented.
Where sensible, plot visual representations of the curved orders produced, or the links between block orders - adding a visual element helps with understanding and trust.
Run the notebooks and check-in the results so anyone viewing the repo can see the results.
Downloading the source code should allow these notebooks to be runnable locally. And the CI should also run them without errors as another build check.
In a folder called 'examples', we need 3 or 4 notebooks which showcase the different functionality of the product and also serve as training material.
They should be based on real-world scenarios, and tackle real world problems.
For each, add a markdown header explaining the purpose, then a prerequisite installation command. Break it into cells for easy reading and each should be documented.
Where sensible, plot visual representations of the curved orders produced, or the links between block orders - adding a visual element helps with understanding and trust.
Run the notebooks and check-in the results so anyone viewing the repo can see the results.
Downloading the source code should allow these notebooks to be runnable locally. And the CI should also run them without errors as another build check.