Skip to content

Commit b6c5bd6

Browse files
deepyamandacbd
andauthored
Hide --rm-watermark option when invoking CML CLI (#1235)
* Hide `--rm-watermark` flag on `cml comment create` * Update create.test.js * Update connect.js * Update connect.test.js * Update publish.js * Update publish.test.js * Update publish.test.js * Update connect.test.js Co-authored-by: Daniel Barnes <dabarnes2b@gmail.com>
1 parent 150a0eb commit b6c5bd6

File tree

6 files changed

+18
-19
lines changed

6 files changed

+18
-19
lines changed

bin/cml/asset/publish.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ exports.options = kebabcaseKeys({
5959
rmWatermark: {
6060
type: 'boolean',
6161
description: 'Avoid CML watermark.',
62+
hidden: true,
6263
telemetryData: 'name'
6364
},
6465
mimeType: {

bin/cml/asset/publish.test.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,11 @@ describe('CML cli test', () => {
2020
--help Show help [boolean]
2121
2222
Options:
23-
--md Output in markdown format [title || name](url) [boolean]
24-
-t, --title Markdown title [title](url) or ![](url title) [string]
25-
--native Uses driver's native capabilities to upload assets instead
26-
of CML's storage; not available on GitHub [boolean]
27-
--rm-watermark Avoid CML watermark. [boolean]
28-
--mime-type MIME type [string] [default: infer from the file contents]"
23+
--md Output in markdown format [title || name](url) [boolean]
24+
-t, --title Markdown title [title](url) or ![](url title) [string]
25+
--native Uses driver's native capabilities to upload assets instead of
26+
CML's storage; not available on GitHub [boolean]
27+
--mime-type MIME type [string] [default: infer from the file contents]"
2928
`);
3029
});
3130
});

bin/cml/comment/create.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ exports.options = kebabcaseKeys({
6666
type: 'boolean',
6767
description:
6868
'Avoid watermark; CML needs a watermark to be able to distinguish CML comments from others',
69+
hidden: true,
6970
telemetryData: 'name'
7071
}
7172
});

bin/cml/comment/create.test.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ describe('Comment integration tests', () => {
3030
[string] [default: \\"https://asset.cml.dev\\"]
3131
--publish-native, --native Uses driver's native capabilities to upload assets
3232
instead of CML's storage; not available on GitHub
33-
[boolean]
34-
--rm-watermark Avoid watermark; CML needs a watermark to be able
35-
to distinguish CML comments from others [boolean]"
33+
[boolean]"
3634
`);
3735
});
3836
});

bin/cml/tensorboard/connect.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ exports.options = kebabcaseKeys({
145145
rmWatermark: {
146146
type: 'boolean',
147147
description: 'Avoid CML watermark',
148+
hidden: true,
148149
telemetryData: 'name'
149150
}
150151
});

bin/cml/tensorboard/connect.test.js

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,16 @@ describe('CML e2e', () => {
2020
--help Show help [boolean]
2121
2222
Options:
23-
-c, --credentials TensorBoard credentials as JSON, usually found at
24-
~/.config/tensorboard/credentials/uploader-creds.json
23+
-c, --credentials TensorBoard credentials as JSON, usually found at
24+
~/.config/tensorboard/credentials/uploader-creds.json
2525
[string] [required]
26-
--logdir Directory containing the logs to process [string]
27-
--name Tensorboard experiment title; max 100 characters [string]
28-
--description Tensorboard experiment description in Markdown format; max
29-
600 characters [string]
30-
--md Output as markdown [title || name](url) [boolean]
31-
-t, --title Markdown title, if not specified, param name will be used
32-
[string]
33-
--rm-watermark Avoid CML watermark [boolean]"
26+
--logdir Directory containing the logs to process [string]
27+
--name Tensorboard experiment title; max 100 characters [string]
28+
--description Tensorboard experiment description in Markdown format; max
29+
600 characters [string]
30+
--md Output as markdown [title || name](url) [boolean]
31+
-t, --title Markdown title, if not specified, param name will be used
32+
[string]"
3433
`);
3534
});
3635
});

0 commit comments

Comments
 (0)