NVIDIA-NeMo / NVIDIA-NeMo/Safe-Synthesizer

Add SDK access to the parameters available for NSS

Open
#522 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area:sdk-cli feature
Dominant language
Python
Stars
38
Forks
11
Avg merge
4d 17h
Merged PRs (30d)
9

Description

Is your feature request related to a problem?

It's currently challenging to get documentation for available parameters on the with_train, with_generate, etc. methods of SafeSynthesizer. While this is all documented in https://nvidia-nemo.github.io/Safe-Synthesizer/latest/reference/nemo_safe_synthesizer/config/training/ and similar locations, it would be more agent friendly to also provide a way to access this in the SDK.

This is separate than the CLI which already provides safe-synthesizer --help.

Describe the solution you'd like

Variety of options are possible. A SafeSynthesizer.help() method may be easiest, though need to generate that string somehow, hopefully automated.

Providing a meaningful docstring for the individual methods is another option, so help(builder.with_train) actually tells you the parameters that are available.

Describe alternatives you've considered

No response

Additional context

No response

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.

Research direction

Start by reading the SafeSynthesizer SDK methods named in the issue, especially with_train and with_generate, and compare their parameter documentation with the existing CLI help from safe-synthesizer --help. Decide how the SDK should expose the available parameters and verify that the resulting help or docstrings cover the documented training and generation options.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.