docs: Add demo of Tuner

[toby-coleman]

Summary

Provides more documentation for the Tuner.

Changes

• New production line example notebook.
• Associated code and YAML.

[gemini-code-assist]

Summary of Changes

Hello @toby-coleman, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new comprehensive demo for the Tuner functionality, specifically showcasing a production line optimization scenario. It provides a Jupyter notebook to simulate a manufacturing process, defines custom plugboard components for the simulation, and demonstrates how to set up and run an optimization job using the Tuner CLI to minimize production costs.

Highlights

• Production Line Simulation Demo: A new Jupyter notebook (production-line.ipynb) has been added, illustrating a detailed production line simulation. This includes defining various components like Input, InputStockpile, Controller, MachineCost, OutputStock, TotalCost, and CostPerUnit to model a manufacturing process.
• Component-Based Modeling: The demo showcases the creation and interconnection of custom plugboard components to build a complex simulation, demonstrating how different aspects of a system (e.g., inventory, costs, control logic) can be modularized.
• Tuner Integration for Optimization: The pull request includes a Python module (production_line.py) and a YAML configuration file (production-line.yaml) that enable the simulation to be used with the Tuner. This setup allows for optimizing parameters, such as controller thresholds, to achieve desired outcomes like minimizing cost per unit.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a new demo for the Tuner feature, showcasing a production line optimization example. The changes include a Jupyter notebook, a Python file with component definitions, and a YAML configuration file. The demo is well-structured and provides a good overview of the Tuner's capabilities.

My review includes a critical fix for the notebook where a connector points to a non-existent component, which would cause a runtime error. I've also suggested several improvements for maintainability, such as parameterizing magic numbers in the components to avoid hardcoding and duplication, and a minor fix for the YAML file format. Overall, this is a great addition to the documentation.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!