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

Change simulator UI help text to refer to directory #839

Merged

Conversation

srstevenson
Copy link
Contributor

When using the mode of the simulator in which you provide an existing index.json file, the help text said to provide the absolute path to the index.json file. However if you do so, the string index.json is then appended to this leading to errors such as:

RuntimeError: No `remote` provided, but local file /home/scott/scratch/dummy-mds-dataset/index.json/index.json does not exist either

This PR changes the help text to instruct the user to provide the path to the directory containing the index.json file, instead of to the file itself.

Before:

After:

When using the mode of the simulator in which you provide an existing
`index.json` file, the help text said to provide the absolute path to
the `index.json` file. However if you do so, the string `index.json` is
then appended to this leading to errors such as:

```
RuntimeError: No `remote` provided, but local file /home/scott/scratch/dummy-mds-dataset/index.json/index.json does not exist either
```

This PR changes the help text to instruct the user to provide the path
to the directory containing the `index.json` file, instead of to the
file itself.
@srstevenson srstevenson force-pushed the srs/change-simulator-ui-help-text-to branch from 37a3e30 to 13333da Compare December 9, 2024 22:06
@snarayan21
Copy link
Collaborator

@srstevenson ah thanks, nice catch! lgtm

Copy link
Collaborator

@snarayan21 snarayan21 left a comment

Choose a reason for hiding this comment

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

lgtm

@snarayan21 snarayan21 merged commit 28a1d02 into mosaicml:main Dec 10, 2024
7 checks passed
@srstevenson srstevenson deleted the srs/change-simulator-ui-help-text-to branch December 10, 2024 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants