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

Show the API for TabularPreset models #854

Closed
npatki opened this issue Jun 28, 2022 · 0 comments · Fixed by #855
Closed

Show the API for TabularPreset models #854

npatki opened this issue Jun 28, 2022 · 0 comments · Fixed by #855
Labels
documentation Docs, user guides or API
Milestone

Comments

@npatki
Copy link
Contributor

npatki commented Jun 28, 2022

Problem Description

If I want to use a TabularPreset, I can get started with the User Guide. However, the guide only covers a portion of all the features and parameters that are available to me. There is no place to view the API.

Expected behavior

The full specs for TabularPreset should be visible in the API section. To be consistent, I expect a high-level item for the sdv.lite module, a sub-heading for the Tabular Preset model, and then the individual APIs for each function:

  • sdv.lite
    • TabularPreset
      • TabularPreset
      • TabularPreset.fit
      • TabularPreset.sample
      • etc.
@npatki npatki added the documentation Docs, user guides or API label Jun 28, 2022
@pvk-developer pvk-developer added this to the 0.16.0 milestone Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Docs, user guides or API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants