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.

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

Add experiment run reset to menus #1719

Merged
merged 5 commits into from
May 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
90 changes: 71 additions & 19 deletions extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,15 @@
"dark": "resources/dark/run-experiment.svg"
}
},
{
"title": "%command.modifyExperimentParamsResetAndRun%",
"command": "dvc.modifyExperimentParamsResetAndRun",
"category": "DVC",
"icon": {
"light": "resources/light/run-experiment.svg",
"dark": "resources/dark/run-experiment.svg"
}
},
{
"title": "%command.queueExperiment%",
"command": "dvc.queueExperiment",
Expand Down Expand Up @@ -415,6 +424,15 @@
"dark": "resources/dark/run-experiment.svg"
}
},
{
"title": "%command.views.experimentsTree.resetRunExperiment%",
"command": "dvc.views.experimentsTree.resetRunExperiment",
"category": "DVC",
"icon": {
"light": "resources/light/run-experiment.svg",
"dark": "resources/dark/run-experiment.svg"
}
},
{
"title": "%command.views.experimentsTree.selectExperiments%",
"command": "dvc.views.experimentsTree.selectExperiments",
Expand Down Expand Up @@ -508,11 +526,11 @@
},
{
"command": "dvc.applyExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.branchExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.checkout",
Expand Down Expand Up @@ -552,7 +570,7 @@
},
{
"command": "dvc.experimentGarbageCollect",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.findInFolder",
Expand Down Expand Up @@ -596,23 +614,27 @@
},
{
"command": "dvc.modifyExperimentParamsAndQueue",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.modifyExperimentParamsAndRun",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.modifyExperimentParamsResetAndRun",
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.queueExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.removeExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.removeExperimentQueue",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.removeExperimentsTableFilters",
Expand All @@ -624,7 +646,7 @@
},
{
"command": "dvc.removeQueuedExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.removeTarget",
Expand All @@ -640,15 +662,15 @@
},
{
"command": "dvc.runExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.runQueuedExperiments",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.runResetExperiment",
"when": "dvc.commands.available && dvc.project.available"
"when": "dvc.commands.available && dvc.project.available && !dvc.runner.running"
},
{
"command": "dvc.selectForCompare",
Expand Down Expand Up @@ -959,10 +981,15 @@
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|branch|experiment|queued)$/ && !dvc.runner.running"
},
{
"command": "dvc.views.experimentsTree.queueExperiment",
"command": "dvc.views.experimentsTree.resetRunExperiment",
"group": "1_do@2",
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|branch|experiment|queued)$/ && !dvc.runner.running"
},
{
"command": "dvc.views.experimentsTree.queueExperiment",
"group": "1_do@3",
"when": "view == dvc.views.experimentsTree && dvc.commands.available && viewItem =~ /^(workspace|branch|experiment|queued)$/ && !dvc.runner.running"
},
{
"command": "dvc.views.experimentsTree.selectExperiments",
"group": "inline",
Expand Down Expand Up @@ -1007,14 +1034,29 @@
},
{
"command": "dvc.runExperiment",
"when": "view == dvc.views.experimentsTree && !dvc.experiments.webviewActive",
"when": "view == dvc.views.experimentsTree && !dvc.experiments.webviewActive && !dvc.runner.running",
"group": "1_run@1"
},
{
"command": "dvc.runExperiment",
"when": "view == dvc.views.experimentsTree && dvc.experiments.webviewActive",
"when": "view == dvc.views.experimentsTree && dvc.experiments.webviewActive && !dvc.runner.running",
"group": "navigation@1"
},
{
"command": "dvc.stopRunningExperiment",
"when": "view == dvc.views.experimentsTree && !dvc.experiments.webviewActive && dvc.runner.running",
"group": "1_run@1"
},
{
"command": "dvc.stopRunningExperiment",
"when": "view == dvc.views.experimentsTree && dvc.experiments.webviewActive && dvc.runner.running",
"group": "navigation@1"
},
{
"command": "dvc.runResetExperiment",
"when": "view == dvc.views.experimentsTree && !dvc.runner.running",
"group": "1_run@2"
},
{
"command": "dvc.showPlots",
"when": "view == dvc.views.experimentsTree && !dvc.plots.webviewActive",
Expand All @@ -1028,17 +1070,27 @@
{
"command": "dvc.runQueuedExperiments",
"when": "view == dvc.views.experimentsTree && !dvc.runner.running",
"group": "1_run@2"
"group": "1_run@3"
},
{
"command": "dvc.queueExperiment",
"command": "dvc.modifyExperimentParamsAndRun",
"when": "view == dvc.views.experimentsTree && !dvc.runner.running",
"group": "2_queue@1"
"group": "2_modify@1"
},
{
"command": "dvc.modifyExperimentParamsResetAndRun",
"when": "view == dvc.views.experimentsTree && !dvc.runner.running",
"group": "2_modify@2"
},
{
"command": "dvc.modifyExperimentParamsAndQueue",
"when": "view == dvc.views.experimentsTree && !dvc.runner.running",
"group": "2_queue@2"
"group": "2_modify@3"
},
{
"command": "dvc.queueExperiment",
"when": "view == dvc.views.experimentsTree && !dvc.runner.running",
"group": "3_queue@1"
},
{
"command": "dvc.views.experimentsTree.autoApplyFilters",
Expand Down
2 changes: 2 additions & 0 deletions extension/package.nls.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"command.pushTarget": "Push",
"command.modifyExperimentParamsAndQueue": "Modify Experiment Param(s) and Queue",
"command.modifyExperimentParamsAndRun": "Modify Experiment Param(s) and Run",
"command.modifyExperimentParamsResetAndRun": "Modify Experiment Param(s) Reset and Run",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"command.modifyExperimentParamsResetAndRun": "Modify Experiment Param(s) Reset and Run",
"command.modifyExperimentParamsResetAndRun": "Modify Experiment Param(s), Reset and Run",

"command.queueExperiment": "Queue Experiment",
"command.removeExperiment": "Remove Experiment",
"command.removeExperimentQueue": "Remove All Queued Experiments",
Expand Down Expand Up @@ -60,6 +61,7 @@
"command.views.experimentsTree.queueExperiment": "Modify Param(s) and Queue",
"command.views.experimentsTree.removeExperiment": "Remove",
"command.views.experimentsTree.runExperiment": "Modify Param(s) and Run",
"command.views.experimentsTree.resetRunExperiment": "Modify Param(s) Reset and Run",
Copy link
Contributor

@dberenbaum dberenbaum May 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"command.views.experimentsTree.resetRunExperiment": "Modify Param(s) Reset and Run",
"command.views.experimentsTree.resetRunExperiment": "Modify Param(s), Reset and Run",

"command.views.experimentsTree.selectExperiments": "Select Experiments to Display in Plots",
"command.views.plotsPathsTree.selectPlots": "Select Plots to Display",
"config.doNotRecommendRedHatExtension.description": "Do not prompt to install the Red Hat YAML extension to assist with DVC YAML schema validation.",
Expand Down
2 changes: 2 additions & 0 deletions extension/src/commands/external.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export enum RegisteredCommands {
EXPERIMENT_TREE_QUEUE = 'dvc.views.experimentsTree.queueExperiment',
EXPERIMENT_TREE_REMOVE = 'dvc.views.experimentsTree.removeExperiment',
EXPERIMENT_TREE_RUN = 'dvc.views.experimentsTree.runExperiment',
EXPERIMENT_TREE_RUN_RESET = 'dvc.views.experimentsTree.resetRunExperiment',
EXPERIMENT_SELECT = 'dvc.views.experimentsTree.selectExperiments',
EXPERIMENT_SHOW = 'dvc.showExperiments',
EXPERIMENT_SORT_ADD = 'dvc.addExperimentsTableSort',
Expand All @@ -46,6 +47,7 @@ export enum RegisteredCommands {
EXPERIMENT_TOGGLE = 'dvc.views.experimentsTree.toggleStatus',
MODIFY_EXPERIMENT_PARAMS_AND_QUEUE = 'dvc.modifyExperimentParamsAndQueue',
MODIFY_EXPERIMENT_PARAMS_AND_RUN = 'dvc.modifyExperimentParamsAndRun',
MODIFY_EXPERIMENT_PARAMS_RESET_AND_RUN = 'dvc.modifyExperimentParamsResetAndRun',
STOP_EXPERIMENT = 'dvc.stopRunningExperiment',

PLOTS_PATH_TOGGLE = 'dvc.views.plotsPathsTree.toggleStatus',
Expand Down
10 changes: 10 additions & 0 deletions extension/src/experiments/commands/register.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ const registerExperimentCwdCommands = (
)
)

internalCommands.registerExternalCommand(
RegisteredCommands.MODIFY_EXPERIMENT_PARAMS_RESET_AND_RUN,
() =>
experiments.pauseUpdatesThenRun(() =>
experiments.modifyExperimentParamsAndRun(
AvailableCommands.EXPERIMENT_RUN_RESET
)
)
)

internalCommands.registerExternalCliCommand(
RegisteredCliCommands.EXPERIMENT_REMOVE_QUEUE,
() =>
Expand Down
6 changes: 6 additions & 0 deletions extension/src/experiments/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,12 @@ export class Experiments extends BaseRepository<TableData> {
AvailableCommands.EXPERIMENT_RUN,
message.payload
)
case MessageFromWebviewType.VARY_EXPERIMENT_PARAMS_RESET_AND_RUN:
return this.modifyExperimentParamsAndRun(
AvailableCommands.EXPERIMENT_RUN_RESET,
message.payload
)

case MessageFromWebviewType.REMOVE_EXPERIMENT:
return this.removeExperiment(message.payload)
default:
Expand Down
10 changes: 10 additions & 0 deletions extension/src/experiments/model/tree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,16 @@ export class ExperimentsTree
)
)

internalCommands.registerExternalCommand<ExperimentItem>(
RegisteredCommands.EXPERIMENT_TREE_RUN_RESET,
({ dvcRoot, id }: ExperimentItem) =>
this.experiments.modifyExperimentParamsAndRun(
AvailableCommands.EXPERIMENT_RUN_RESET,
dvcRoot,
id
)
)

internalCommands.registerExternalCommand<ExperimentItem>(
RegisteredCommands.EXPERIMENT_TREE_REMOVE,
({ dvcRoot, id }: ExperimentItem) =>
Expand Down
2 changes: 2 additions & 0 deletions extension/src/telemetry/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,12 @@ export interface IEventNamePropertyMapping {
[EventName.EXPERIMENT_TREE_QUEUE]: undefined
[EventName.EXPERIMENT_TREE_REMOVE]: undefined
[EventName.EXPERIMENT_TREE_RUN]: undefined
[EventName.EXPERIMENT_TREE_RUN_RESET]: undefined
[EventName.EXPERIMENT_TOGGLE]: undefined
[EventName.QUEUE_EXPERIMENT]: undefined
[EventName.MODIFY_EXPERIMENT_PARAMS_AND_QUEUE]: undefined
[EventName.MODIFY_EXPERIMENT_PARAMS_AND_RUN]: undefined
[EventName.MODIFY_EXPERIMENT_PARAMS_RESET_AND_RUN]: undefined
[EventName.STOP_EXPERIMENT]: { stopped: boolean; wasRunning: boolean }

[EventName.PLOTS_PATH_TOGGLE]: undefined
Expand Down
32 changes: 32 additions & 0 deletions extension/src/test/suite/experiments/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,38 @@ suite('Experiments Test Suite', () => {
)
})

it("should be able to handle a message to modify an experiment's params reset and run a new experiment", async () => {
const { experiments, mockExecuteCommand } =
setupExperimentsAndMockCommands()

const mockModifiedParams = [
'-S',
'params.yaml:lr=0.0001',
'-S',
'params.yaml:weight_decay=0.2'
]

stub(experiments, 'pickAndModifyParams').resolves(mockModifiedParams)

const webview = await experiments.showWebview()
const mockMessageReceived = getMessageReceivedEmitter(webview)
const mockExperimentId = 'mock-experiment-id'
const tableChangePromise = experimentsUpdatedEvent(experiments)

mockMessageReceived.fire({
payload: mockExperimentId,
type: MessageFromWebviewType.VARY_EXPERIMENT_PARAMS_RESET_AND_RUN
})

await tableChangePromise
expect(mockExecuteCommand).to.be.calledOnce
expect(mockExecuteCommand).to.be.calledWithExactly(
AvailableCommands.EXPERIMENT_RUN_RESET,
dvcDemoPath,
...mockModifiedParams
)
})

it('should be able to handle a message to remove an experiment', async () => {
const { experiments, mockExecuteCommand } =
setupExperimentsAndMockCommands()
Expand Down
65 changes: 65 additions & 0 deletions extension/src/test/suite/experiments/model/tree.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -580,4 +580,69 @@ suite('Experiments Tree Test Suite', () => {
)
})
})

it('should be able to reset and run a new experiment from an existing one with dvc.views.experimentsTree.resetRunExperiment', async () => {
const baseExperimentId = 'workspace'

const { cliRunner, experiments, experimentsModel } =
buildExperiments(disposable)

await experiments.isReady()

const mockRunExperimentReset = stub(
cliRunner,
'runExperimentReset'
).resolves(undefined)

const mockGetOnlyOrPickProject = stub(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(WorkspaceExperiments as any).prototype,
'getOnlyOrPickProject'
)
stub(WorkspaceExperiments.prototype, 'getRepository').returns(experiments)

const getParamsSpy = spy(experimentsModel, 'getExperimentParams')

const mockShowQuickPick = stub(window, 'showQuickPick') as SinonStub<
[items: readonly QuickPickItem[], options: QuickPickOptionsWithTitle],
Thenable<QuickPickItem[] | QuickPickItemWithValue<string> | undefined>
>
mockShowQuickPick.resolves([
{
label: 'params.yaml:dropout',
value: { path: 'params.yaml:dropout', value: 0.1 }
},
{
label: 'params.yaml:process.threshold',
value: { path: 'params.yaml:process.threshold', value: 0.8 }
}
] as QuickPickItemWithValue<Param>[])

stub(window, 'showInputBox')
.onFirstCall()
.resolves('0.11')
.onSecondCall()
.resolves('0.82')

await commands.executeCommand(
RegisteredCommands.EXPERIMENT_TREE_RUN_RESET,
{
dvcRoot: dvcDemoPath,
id: baseExperimentId
}
)

expect(mockGetOnlyOrPickProject).not.to.be.called
expect(getParamsSpy).to.be.calledOnce
expect(getParamsSpy).to.be.calledWithExactly(baseExperimentId)
expect(mockShowQuickPick).to.be.calledOnce
expect(mockRunExperimentReset).to.be.calledOnce
expect(mockRunExperimentReset).to.be.calledWith(
dvcDemoPath,
'-S',
'params.yaml:dropout=0.11',
'-S',
'params.yaml:process.threshold=0.82'
)
})
})
Loading