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

Show experiment names in comparison table headers (#1614) #1730

Merged
merged 5 commits into from
May 20, 2022
Merged

Show experiment names in comparison table headers (#1614) #1730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e84c129
Show experiment names in comparison table headers (#1614)
wolmir May 17, 2022
d1d6031
Fix integration tests
wolmir May 17, 2022
ac9c7ef
Add group property to comparison data
wolmir May 20, 2022
92d7c27
Fix test fixtures
wolmir May 20, 2022
1f77030
Remove commented css
wolmir May 20, 2022
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
36 changes: 34 additions & 2 deletions extension/src/experiments/model/collect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,32 @@ const getDisplayNameOrParent = (
}
}

const getLogicalGroupName = (
sha: string,
branchSha: string,
experimentsObject: { [sha: string]: ExperimentFieldsOrError }
): string | undefined => {
const experiment = experimentsObject[sha]?.data

// if (!experiment) {
// return
// }
Copy link
Contributor

Choose a reason for hiding this comment

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

[Q] What happened here?


const { checkpoint_tip: checkpointTip = undefined, name = undefined } =
experiment || {}

if (name) {
return `[${name}]`
}

return (
getDisplayNameOrParent(sha, branchSha, experimentsObject) ||
(checkpointTip && checkpointTip !== sha
? getLogicalGroupName(checkpointTip, branchSha, experimentsObject)
: undefined)
)
}

const getCheckpointTipId = (
checkpointTip: string | undefined,
experimentsObject: ExperimentsObject
Expand Down Expand Up @@ -89,7 +115,8 @@ const transformExperimentData = (
experimentFields: ExperimentFields,
label: string | undefined,
sha?: string,
displayNameOrParent?: string
displayNameOrParent?: string,
logicalGroupName?: string
): Experiment => {
const experiment = {
id,
Expand All @@ -101,6 +128,10 @@ const transformExperimentData = (
experiment.displayNameOrParent = displayNameOrParent
}

if (logicalGroupName) {
experiment.logicalGroupName = logicalGroupName
}

if (sha) {
experiment.sha = sha
}
Expand Down Expand Up @@ -138,7 +169,8 @@ const transformExperimentOrCheckpointData = (
experimentFields,
getShortSha(sha),
sha,
getDisplayNameOrParent(sha, branchSha, experimentsObject)
getDisplayNameOrParent(sha, branchSha, experimentsObject),
getLogicalGroupName(sha, branchSha, experimentsObject)
)
}
}
Expand Down
1 change: 1 addition & 0 deletions extension/src/experiments/webview/contract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export interface Experiment extends BaseExperimentFields {
id: string
label: string
displayNameOrParent?: string
logicalGroupName?: string
params?: Columns
metrics?: Columns
displayColor?: string
Expand Down
3 changes: 2 additions & 1 deletion extension/src/plots/model/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,9 @@ export class PlotsModel extends ModelWithPersistence {
this.comparisonOrder,
this.experiments
.getSelectedRevisions()
.map(({ label: revision, displayColor }) => ({
.map(({ label: revision, displayColor, logicalGroupName }) => ({
displayColor,
group: logicalGroupName,
revision
})),
'revision'
Expand Down
6 changes: 5 additions & 1 deletion extension/src/plots/webview/contract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ export type ComparisonPlots = {
revisions: ComparisonRevisionData
}[]

export type ComparisonRevision = { revision: string; displayColor: Color }
export type ComparisonRevision = {
revision: string
group?: string
displayColor: Color
}

export interface PlotsComparisonData {
revisions: ComparisonRevision[]
Expand Down
12 changes: 12 additions & 0 deletions extension/src/test/fixtures/expShow/rows.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ const data: Row[] = [
name: 'exp-e7a67',
checkpoint_parent: 'd1343a87c6ee4a2e82d19525964d2fb2cb6756c9',
label: '4fb124a',
logicalGroupName: '[exp-e7a67]',
displayNameOrParent: '[exp-e7a67]',
displayColor: colorsList[2],
id: 'exp-e7a67',
Expand Down Expand Up @@ -133,6 +134,7 @@ const data: Row[] = [
},
checkpoint_parent: '1ee5f2ecb0fa4d83cbf614386536344cf894dd53',
label: 'd1343a8',
logicalGroupName: '[exp-e7a67]',
displayColor: undefined,
id: 'd1343a87c6ee4a2e82d19525964d2fb2cb6756c9',
selected: false,
Expand Down Expand Up @@ -168,6 +170,7 @@ const data: Row[] = [
checkpoint_parent: '53c3851f46955fa3e2b8f6e1c52999acc8c9ea77',
displayColor: undefined,
label: '1ee5f2e',
logicalGroupName: '[exp-e7a67]',
id: '1ee5f2ecb0fa4d83cbf614386536344cf894dd53',
selected: false,
sha: '1ee5f2ecb0fa4d83cbf614386536344cf894dd53'
Expand Down Expand Up @@ -206,6 +209,7 @@ const data: Row[] = [
checkpoint_parent: '217312476f8854dda1865450b737eb6bc7a3ba1b',
displayColor: colorsList[3],
label: '42b8736',
logicalGroupName: '[test-branch]',
displayNameOrParent: '[test-branch]',
id: 'test-branch',
sha: '42b8736b08170529903cd203a1f40382a4b4a8cd',
Expand Down Expand Up @@ -240,6 +244,7 @@ const data: Row[] = [
checkpoint_parent: '9523bde67538cf31230efaff2dbc47d38a944ab5',
displayColor: undefined,
label: '2173124',
logicalGroupName: '[test-branch]',
id: '217312476f8854dda1865450b737eb6bc7a3ba1b',
selected: false,
sha: '217312476f8854dda1865450b737eb6bc7a3ba1b'
Expand Down Expand Up @@ -274,6 +279,7 @@ const data: Row[] = [
checkpoint_parent: '53c3851f46955fa3e2b8f6e1c52999acc8c9ea77',
displayColor: undefined,
label: '9523bde',
logicalGroupName: '[test-branch]',
id: '9523bde67538cf31230efaff2dbc47d38a944ab5',
selected: false,
sha: '9523bde67538cf31230efaff2dbc47d38a944ab5'
Expand Down Expand Up @@ -312,6 +318,7 @@ const data: Row[] = [
checkpoint_parent: '22e40e1fa3c916ac567f69b85969e3066a91dda4',
displayColor: colorsList[4],
label: '1ba7bcd',
logicalGroupName: '[exp-83425]',
displayNameOrParent: '[exp-83425]',
id: 'exp-83425',
sha: '1ba7bcd6ce6154e72e18b155475663ecbbd1f49d',
Expand Down Expand Up @@ -346,6 +353,7 @@ const data: Row[] = [
checkpoint_parent: '91116c1eae4b79cb1f5ab0312dfd9b3e43608e15',
displayColor: undefined,
label: '22e40e1',
logicalGroupName: '[exp-83425]',
id: '22e40e1fa3c916ac567f69b85969e3066a91dda4',
selected: false,
sha: '22e40e1fa3c916ac567f69b85969e3066a91dda4'
Expand Down Expand Up @@ -380,6 +388,7 @@ const data: Row[] = [
checkpoint_parent: 'e821416bfafb4bc28b3e0a8ddb322505b0ad2361',
displayColor: undefined,
label: '91116c1',
logicalGroupName: '[exp-83425]',
id: '91116c1eae4b79cb1f5ab0312dfd9b3e43608e15',
selected: false,
sha: '91116c1eae4b79cb1f5ab0312dfd9b3e43608e15'
Expand Down Expand Up @@ -414,6 +423,7 @@ const data: Row[] = [
checkpoint_parent: 'c658f8b14ac819ac2a5ea0449da6c15dbe8eb880',
displayColor: undefined,
label: 'e821416',
logicalGroupName: '[exp-83425]',
id: 'e821416bfafb4bc28b3e0a8ddb322505b0ad2361',
selected: false,
sha: 'e821416bfafb4bc28b3e0a8ddb322505b0ad2361'
Expand Down Expand Up @@ -448,6 +458,7 @@ const data: Row[] = [
checkpoint_parent: '23250b33e3d6dd0e136262d1d26a2face031cb03',
displayColor: undefined,
label: 'c658f8b',
logicalGroupName: '[exp-83425]',
id: 'c658f8b14ac819ac2a5ea0449da6c15dbe8eb880',
selected: false,
sha: 'c658f8b14ac819ac2a5ea0449da6c15dbe8eb880'
Expand Down Expand Up @@ -482,6 +493,7 @@ const data: Row[] = [
checkpoint_parent: '53c3851f46955fa3e2b8f6e1c52999acc8c9ea77',
displayColor: undefined,
label: '23250b3',
logicalGroupName: '[exp-83425]',
id: '23250b33e3d6dd0e136262d1d26a2face031cb03',
selected: false,
sha: '23250b33e3d6dd0e136262d1d26a2face031cb03'
Expand Down
26 changes: 21 additions & 5 deletions extension/src/test/fixtures/plotsDiff/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,11 +545,27 @@ export const getComparisonWebviewMessage = (
return {
plots: plotAcc,
revisions: [
{ revision: 'workspace', displayColor: workspace },
{ revision: 'main', displayColor: main },
{ revision: '4fb124a', displayColor: _4fb124a },
{ revision: '42b8736', displayColor: _42b8735 },
{ revision: '1ba7bcd', displayColor: _1ba7bcd }
{
revision: 'workspace',
displayColor: workspace,
group: undefined
},
{ revision: 'main', displayColor: main, group: undefined },
{
revision: '4fb124a',
displayColor: _4fb124a,
group: '[exp-e7a67]'
},
{
revision: '42b8736',
displayColor: _42b8735,
group: '[test-branch]'
},
{
revision: '1ba7bcd',
displayColor: _1ba7bcd,
group: '[exp-83425]'
}
],
sectionName: DEFAULT_SECTION_NAMES[Section.COMPARISON_TABLE],
size: PlotSize.REGULAR
Expand Down
42 changes: 35 additions & 7 deletions extension/src/test/suite/experiments/model/tree.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,13 +307,41 @@ suite('Experiments Tree Test Suite', () => {
plotsModel.getSelectedRevisionDetails(),
'all running and the most recent experiments are now selected'
).to.deep.equal([
{ displayColor: colors[0], revision: 'workspace' },
{ displayColor: colors[2], revision: '4fb124a' },
{ displayColor: colors[3], revision: '42b8736' },
{ displayColor: colors[1], revision: 'd1343a8' },
{ displayColor: colors[4], revision: '1ee5f2e' },
{ displayColor: colors[5], revision: '2173124' },
{ displayColor: colors[6], revision: '9523bde' }
{
displayColor: colors[0],
group: undefined,
revision: 'workspace'
},
{
displayColor: colors[2],
group: '[exp-e7a67]',
revision: '4fb124a'
},
{
displayColor: colors[3],
group: '[test-branch]',
revision: '42b8736'
},
{
displayColor: colors[1],
group: '[exp-e7a67]',
revision: 'd1343a8'
},
{
displayColor: colors[4],
group: '[exp-e7a67]',
revision: '1ee5f2e'
},
{
displayColor: colors[5],
group: '[test-branch]',
revision: '2173124'
},
{
displayColor: colors[6],
group: '[test-branch]',
revision: '9523bde'
}
])
expect(
mockPlotsDiff,
Expand Down
40 changes: 25 additions & 15 deletions webview/src/plots/components/comparisonTable/ComparisonTable.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ describe('ComparisonTable', () => {

const basicProps: ComparisonTableProps = comparisonTableFixture
const revisions = basicProps.revisions.map(({ revision }) => revision)
const namedRevisions = basicProps.revisions.map(
({ revision, group }) => `${revision}${group || ''}`
)
const renderTable = (props = basicProps) =>
render(
<DragDropProvider>
Expand Down Expand Up @@ -179,7 +182,7 @@ describe('ComparisonTable', () => {

let headers = getHeaders().map(header => header.textContent)

expect(headers).toStrictEqual(revisions)
expect(headers).toStrictEqual(namedRevisions)

const filteredRevisions = basicProps.revisions.filter(
({ revision }) => revision !== revisions[3]
Expand All @@ -189,12 +192,11 @@ describe('ComparisonTable', () => {

headers = getHeaders().map(header => header.textContent)

expect(headers).toStrictEqual([
revisions[0],
revisions[1],
revisions[2],
revisions[4]
])
const expectedRevisions = filteredRevisions.map(
({ revision, group }) => `${revision}${group || ''}`
)

expect(headers).toStrictEqual(expectedRevisions)
})

it('should add a new column if there is a new revision', () => {
Expand All @@ -208,7 +210,7 @@ describe('ComparisonTable', () => {
rerender(<ComparisonTable {...basicProps} revisions={newRevisions} />)
const headers = getHeaders().map(header => header.textContent)

expect(headers).toStrictEqual([...revisions, newRevName])
expect(headers).toStrictEqual([...namedRevisions, newRevName])
})

it('should pin the current pinned column on first render', () => {
Expand Down Expand Up @@ -254,12 +256,20 @@ describe('ComparisonTable', () => {

let headers = getHeaders().map(header => header.textContent)

expect(headers).toStrictEqual(revisions)
expect(headers).toStrictEqual(namedRevisions)

dragAndDrop(startingNode, endingNode)

headers = getHeaders().map(header => header.textContent)

const expectedNamedRevisions = [
namedRevisions[0],
namedRevisions[3],
namedRevisions[1],
namedRevisions[2],
namedRevisions[4]
]

const expectedRevisions = [
revisions[0],
revisions[3],
Expand All @@ -268,7 +278,7 @@ describe('ComparisonTable', () => {
revisions[4]
]

expect(headers).toStrictEqual(expectedRevisions)
expect(headers).toStrictEqual(expectedNamedRevisions)
expect(mockPostMessage).toBeCalledTimes(1)
expect(mockPostMessage).toBeCalledWith({
payload: expectedRevisions,
Expand All @@ -283,11 +293,11 @@ describe('ComparisonTable', () => {

const [, endingNode, , startingNode] = getHeaders()
const expectedOrder = [
revisions[1],
revisions[0],
revisions[2],
revisions[3],
revisions[4]
namedRevisions[1],
namedRevisions[0],
namedRevisions[2],
namedRevisions[3],
namedRevisions[4]
]

const headers = getHeaders().map(header => header.textContent)
Expand Down
3 changes: 2 additions & 1 deletion webview/src/plots/components/comparisonTable/ComparisonTableHead.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const ComparisonTableHead: React.FC<ComparisonTableHeadProps> = ({
setColumnsOrder,
setPinnedColumn
}) => {
const items = columns.map(({ revision, displayColor }) => {
const items = columns.map(({ revision, displayColor, group }) => {
const isPinned = revision === pinnedColumn
return (
<th
Expand All @@ -37,6 +37,7 @@ export const ComparisonTableHead: React.FC<ComparisonTableHeadProps> = ({
displayColor={displayColor}
>
{revision}
{group && <span className={styles.experimentName}>{group}</span>}
</ComparisonTableHeader>
</th>
)
Expand Down
4 changes: 4 additions & 0 deletions webview/src/plots/components/comparisonTable/styles.module.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,7 @@ $gap: 4px;
width: 100%;
height: auto;
}

.experimentName {
color: $meta-cell-color;
}