deepspeedai / deepspeedai/DeepSpeed

Schema for ds_config.json

Open
#2,355 1 comment 3 reactions 1 assignee View on GitHub

@mrwyattii is already working on this.

Since Nov 11, 2022.

enhancement training
Dominant language
Python
Stars
43.1k
Forks
5k
Avg merge
4d 15h
Merged PRs (30d)
112

Description

Is your feature request related to a problem?
It is hard for users to know about all the different configuration options when editing a ds_config.json file.

Describe the solution you'd like
A JSON schema file for the ds_config.json should be provided so code editors like VS.Code can support the user in editing the ds_config.json. Benefits would then be for example: in-document descriptions for each setting, code completion, validation.

More details and screenshots at https://code.visualstudio.com/docs/languages/json

Describe alternatives you've considered
JSON schemas are common and would be a great help, especially because the schema for ds_config.json files is really complex. Looking up the documentation lowers productivity.

Additional context
As written above, check out https://code.visualstudio.com/docs/languages/json for details and examples.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.