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.

Sign up for GitHub

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

Jump to bottom

User Guide code fixes #983

Closed
npatki opened this issue Aug 30, 2022 · 0 comments · Fixed by #989
Closed

User Guide code fixes #983

npatki opened this issue Aug 30, 2022 · 0 comments · Fixed by #989
Assignees
@amontanez24
Labels
bug Something isn't working documentation Docs, user guides or API
Milestone
0.17.0

Comments

@npatki
Copy link
Contributor

npatki commented Aug 30, 2022

Environment Details

  • SDV version: 0.17.0.dev1

Error Description

Some areas of the documentation should be updated to account for the changes in the API.

  1. Evaluation Framework: In "Can I control which metrics are applied?" the examples are exactly the same as the new defaults. We can update to different metrics instead: ['KSTest', 'LogisticDetection']
  2. Custom Constraints: The model creation step references min_value and max_value even though these parameters don't exist anymore. Replace with enforce_min_max_values=False.

We should also run the rest of the code to ensure that there are no errors. (The second bug should've been caught if we had run the code.)
@npatki npatki added bug Something isn't working documentation Docs, user guides or API labels Aug 30, 2022
@npatki npatki added this to the 0.17.0 milestone Aug 30, 2022
@amontanez24 amontanez24 self-assigned this Aug 30, 2022
@amontanez24 amontanez24 mentioned this issue Aug 31, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amontanez24 amontanez24

Labels
bug Something isn't working documentation Docs, user guides or API
Projects
None yet
Milestone
0.17.0
Development

Successfully merging a pull request may close this issue.

User Guide code fixes sdv-dev/SDV
2 participants
@npatki @amontanez24