hitsz-ids / synthetic-data-generator

SDG is a specialized framework designed to generate high-quality structured tabular data.
Apache License 2.0
3.27k stars 545 forks source link

Update documentation and docstrings for DataProcessors #186

Closed MooooCat closed 4 months ago

MooooCat commented 4 months ago

Description

This PR updates the documentation and docstrings for the DataProcessors. The changes include:

  1. Adding a detailed description of the class and its methods to the class docstring.
  2. Updating the documentation in the index.rst file to reflect the changes.

Motivation and Context

he current docstring and documentation are not detailed enough, which makes it difficult for new users to understand how to use DataProcessor. This PR aims to improve the clarity and usability of these classes.

How has this been tested?

We use make html to build the documentation locally to ensure formatting and links are correct.

Types of changes

Checklist:

iokk3732 commented 4 months ago

done