-
Notifications
You must be signed in to change notification settings - Fork 77
docs: Add comprehensive Switch transpiler documentation #2102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
hiroyukinakazato-db
wants to merge
13
commits into
main
Choose a base branch
from
switch-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or 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
Add comprehensive Switch documentation and references to existing docs: - New switch.mdx with installation, usage, and configuration guide - Updated overview.mdx to mention Switch transpiler - Updated transpile/overview.mdx with Switch section and comparison - Updated pluggable_transpilers/index.mdx with Switch installation info Switch is an LLM-powered transpiler using Mosaic AI Model Serving for SQL and generic source format conversion to Databricks notebooks.
- Change installation to require --include-llm-transpiler true flag - Update CLI usage to llm-transpile command - Change input paths from Workspace to local (auto-uploaded to Volume) - Replace --output-folder with --output-ws-folder - Remove --transpiler-config-path and config.yml references - Remove --catalog-name and --schema-name (configured during installation) - Convert configuration from config.yml to command-line arguments - Update all examples to reflect new command structure
… index Switch is now installed as an optional direct dependency rather than in .databricks/labs/remorph-transpilers/switch/
|
✅ 46/46 passed, 7 flaky, 3m23s total Flaky tests:
Running from acceptance #2795 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2102 +/- ##
=======================================
Coverage ? 64.87%
=======================================
Files ? 96
Lines ? 7895
Branches ? 821
=======================================
Hits ? 5122
Misses ? 2593
Partials ? 180 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Changes
This PR adds comprehensive documentation for Switch, an LLM-powered transpiler integrated into Lakebridge. Switch converts SQL and other source formats into Databricks notebooks using Large Language Models.
What does this PR do?
Adds complete documentation for the Switch transpiler, covering installation, usage, configuration, architecture, and troubleshooting. Switch enables LLM-based code conversion through the
llm-transpilecommand, processing local files and uploading them to Unity Catalog Volumes automatically.Relevant implementation details
New Documentation:
docs/lakebridge/docs/transpile/pluggable_transpilers/switch.mdx- Comprehensive Switch guide including:--include-llm-transpiler trueflagllm-transpilecommandUpdated Existing Documentation:
docs/lakebridge/docs/overview.mdx- Added Switch to transpiler listdocs/lakebridge/docs/transpile/overview.mdx- Added Switch section with key characteristicsdocs/lakebridge/docs/transpile/pluggable_transpilers/index.mdx- Updated to mention Switch installationCaveats/things to watch out for when reviewing:
llm-transpilecommand usage documentation inswitch.mdxmay need updates as the integration implementation evolvesllm-transpilecommand takes local input paths and automatically uploads to Volumes--endpoint-name) which are converted to job parameters (e.g.,endpoint_name)Linked issues
Resolves #2044
Functionality
databricks labs lakebridge ...Tests