Skip to content

Commit

Permalink
Adjust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qubixes committed Oct 18, 2024
1 parent 6f69e97 commit d02f206
Show file tree
Hide file tree
Showing 5 changed files with 120 additions and 622 deletions.
6 changes: 4 additions & 2 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ The process of generating synthetic data solely from the MetaFrame ensures that



**I encountered the warning: "Variable PassengerId seems unique, but not set to be unique." What should I do?**
-----------------------------------------------------------------------------------------------------------------
**I encountered the warning: "Metasyn detected that variable {x} is potentially unique." What should I do?**
------------------------------------------------------------------------------------------------------------
This warning occurs when ``metasyn`` detects a column, that seems to have unique values in the real dataset but isn't specified to be unique in the fitting of the :obj:`MetaFrame<metasyn.metaframe.MetaFrame>`. To address this, you can use the `spec` parameter to create a specification dictionary and indicate that the column should have unique values. Here's an example of how to do this (in this example ``PassengerId`` is the column with unique values):

.. code-block:: python
Expand All @@ -40,6 +40,8 @@ This warning occurs when ``metasyn`` detects a column, that seems to have unique
More information on how to use the optional parameters in the :meth:`metasyn.MetaFrame.fit_dataframe() <metasyn.metaframe.MetaFrame.fit_dataframe>` function can be found in :doc:`/usage/generating_metaframes` under :ref:`optionalparams`.

You can also set the uniqueness of a variable in the :doc:`configuration file <usage/config_files>`

**I found a bug/issue, where can I report it?**
-----------------------------------------------
If you encounter any bugs or have identified an issue with metasyn, we encourage you to report it on our `GitHub issue tracker <https://github.com/sodascience/metasyn/issues>`_. This allows us to track and address the problem efficiently. Alternatively, you can find out how to contact us through the details provided in our :doc:`contact page </about/contact>`.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/generating_metaframes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The potential directives include:

When generating a MetaFrame, ``metasyn`` will automatically analyze the columns of the input DataFrame to detect ones that contain only unique values.
If such a column is found, and it has not manually been set to unique in the ``var_specs`` list, the user will be notified with the following warning:
``Variable '[variable name]' was detected to be unique, but has not explicitly been set to unique. To generate only unique values for column 'PassengerId', set unique to True. To dismiss this warning, set unique to False."``
``Metasyn detected that variable '{variable name}' is potentially unique."``

It is safe to ignore this warning - however, be aware that without setting the column as unique, ``metasyn`` may generate duplicate values for that column when synthesizing data.

Expand Down
8 changes: 0 additions & 8 deletions docs/source/usage/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,6 @@ With the DataFrame loaded, you can now generate a :obj:`MetaFrame <metasyn.metaf
This creates a MetaFrame named ``mf``.

.. Note::
At this point you will get a warning because metasyn detects that 'PassengerId' contains unique values, but we did not specify this column to generate only unique values. The warning is as follows:

``Variable 'PassengerId' was detected to be unique, but has not explicitly been set to unique. To generate only unique values for column 'PassengerId', set unique to True. To dismiss this warning, set unique to False."``

The page on :doc:`/usage/generating_metaframes` covers how to set unique argument in order to generate only unique values for a column, or dismiss the warning.


We can inspect the MetaFrame by simply printing it (``print(mf)``). This will produce the following output:

.. code-block::
Expand Down
Loading

0 comments on commit d02f206

Please sign in to comment.