Skip to content
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.

Sign up for GitHub

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

Adds switch for hosted Hamilton instructions #1012

Merged
merged 1 commit into from
Jul 4, 2024
Merged

Adds switch for hosted Hamilton instructions #1012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions ui/frontend/src/components/dashboard/Project/ProjectLogInstructions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,24 @@ import { CheckBox } from "../../common/Checkbox";
const INSTALL_CODE = `# be sure to initialize any python environment you want to use first
pip install "sf-hamilton[sdk]"`;

const INSTALL_CODE_DW = `# be sure to initialize any python environment you want to use first
pip install dagworks-sdk`;

export const UsingHamiltonAlready = (props: {
projectId: string | undefined;
username: string;
useHamiltonSDK: boolean;
}) => {
const exampleCode = `
from hamilton_sdk import adapters
from ${props.useHamiltonSDK ? "hamilton_sdk" : "dagworks"} import adapters
from hamilton import driver
...
tracker = adapters.HamiltonTracker(
tracker = adapters.${props.useHamiltonSDK ? "HamiltonTracker": "DAGWorksTracker"}(
project_id=${props.projectId}, # modify this as needed
username="${props.username}",
dag_name="my_version_of_the_dag",
tags={"environment": "DEV", "team": "MY_TEAM", "version": "X"}
tags={"environment": "DEV", "team": "MY_TEAM", "version": "X"},
${props.useHamiltonSDK ? "": ' api_key="your_api_key"'}
)
dr = (
driver.Builder()
Expand Down Expand Up @@ -64,14 +69,19 @@ dr = (
export const NotUsingHamiltonYet = (props: {
projectId: string | undefined;
username: string;
useHamiltonSDK: boolean;
}) => {
const initCode = `\
git clone https://github.com/DAGWorks-Inc/hamilton.git
const initCode = props.useHamiltonSDK
? `git clone https://github.com/DAGWorks-Inc/hamilton.git
cd hamilton/examples/hamilton_ui
# provide the project ID and username for run.py.
` : `git clone https://github.com/DAGWorks-Inc/dagworks-examples.git
cd dagworks-examples/hello_world/
# modify run.py -- change the username and project_id to your own
`;
const pipCode = `pip install -r requirements.txt`;
const runCode = `python run.py`;
const runCode = props.useHamiltonSDK ? `python run.py` : `python run.py --api-key YOUR_API_KEY`;

return (
<>
<li className="flex flex-col gap-2">
Expand Down Expand Up @@ -133,6 +143,7 @@ export const ProjectLogInstructions = (props: {
}) => {
const NOT_USING_HAMILTON = "Not Using Hamilton (yet)";
const USING_HAMILTON = "Using Hamilton";
const urlContainsDagworks = window.location.href.includes('app.dagworks.io');

const tabs = [NOT_USING_HAMILTON, USING_HAMILTON];
const [currentTab, setCurrentTab] = useState(tabs[1]);
Expand Down Expand Up @@ -171,11 +182,11 @@ export const ProjectLogInstructions = (props: {
<div className="flex flex-row gap-2">
<CheckBox />
<p className="text-sm text-gray-500 items-center">
Install the Hamilton SDK:
Install the SDK:
</p>
</div>
<SyntaxHighlighter language="bash" style={vscDarkPlus}>
{INSTALL_CODE}
{urlContainsDagworks ? INSTALL_CODE_DW : INSTALL_CODE}
</SyntaxHighlighter>
</li>
<div>
Expand Down Expand Up @@ -220,11 +231,13 @@ export const ProjectLogInstructions = (props: {
<UsingHamiltonAlready
projectId={props.projectId?.toString()}
username={props.username}
useHamiltonSDK={!urlContainsDagworks}
/>
) : (
<NotUsingHamiltonYet
projectId={props.projectId?.toString()}
username={props.username}
useHamiltonSDK={!urlContainsDagworks}
/>
)}
</div>
Expand Down
Loading