From 8d0f5bc3d5e387aedd73be184d573bacb5defbbb Mon Sep 17 00:00:00 2001 From: Fabiana Clemente Date: Tue, 7 May 2024 10:53:26 -0700 Subject: [PATCH] docs: update links in the documentation --- docs/advanced_settings/analytics.md | 2 +- docs/advanced_settings/available_settings.md | 2 ++ docs/advanced_settings/caching.md | 4 +++- docs/advanced_settings/changing_settings.md | 2 ++ docs/advanced_settings/collaborative_data_profiling.md | 2 ++ docs/features/big_data.md | 2 ++ docs/features/collaborative_data_profiling.md | 2 ++ docs/features/comparing_datasets.md | 1 + docs/features/custom_reports.md | 4 +++- docs/features/metadata.md | 2 ++ docs/features/pii_identification_management.md | 2 +- docs/features/sensitive_data.md | 4 +++- docs/features/time_series_datasets.md | 4 +++- docs/getting-started/concepts.md | 4 +++- docs/getting-started/examples.md | 2 ++ docs/getting-started/installation.md | 2 ++ docs/getting-started/quickstart.md | 2 ++ docs/integrations/bytewax.md | 4 +++- docs/integrations/great_expectations.md | 4 +++- docs/integrations/ides.md | 2 ++ docs/integrations/interactive_applications.md | 2 ++ docs/integrations/other_dataframe_libraries.md | 2 ++ docs/integrations/pipelines.md | 2 ++ docs/integrations/pyspark.md | 2 ++ docs/reference/history.md | 2 ++ docs/reference/resources.md | 2 ++ docs/support-contribution/common_issues.md | 2 ++ docs/support-contribution/contribution_guidelines.md | 2 ++ docs/support-contribution/help_troubleshoot.md | 2 ++ 29 files changed, 62 insertions(+), 9 deletions(-) diff --git a/docs/advanced_settings/analytics.md b/docs/advanced_settings/analytics.md index 39a7da16c..e21913b1d 100644 --- a/docs/advanced_settings/analytics.md +++ b/docs/advanced_settings/analytics.md @@ -39,4 +39,4 @@ Open your terminal or command prompt and set the YDATA_PROFILING_NO_ANALYTICS en os.environ['YDATA_PROFILING_NO_ANALYTICS'] = 'True' ```` - + diff --git a/docs/advanced_settings/available_settings.md b/docs/advanced_settings/available_settings.md index e03577032..ff9917958 100644 --- a/docs/advanced_settings/available_settings.md +++ b/docs/advanced_settings/available_settings.md @@ -121,3 +121,5 @@ Settings related with the interactions section. Settings related with the appearance and style of the report. {{ read_csv('./tables/config_html.csv') }} + + \ No newline at end of file diff --git a/docs/advanced_settings/caching.md b/docs/advanced_settings/caching.md index bb7547962..77d4adbbd 100644 --- a/docs/advanced_settings/caching.md +++ b/docs/advanced_settings/caching.md @@ -6,4 +6,6 @@ If you modify the configuration in-between runs, either a new ``ProfileReport`` - *rendering* to invalidate previously rendered reports (HTML, JSON or widgets) - *report* to remove the caching of the report's structure -- *None* (default) to invalidate all caches \ No newline at end of file +- *None* (default) to invalidate all caches + + \ No newline at end of file diff --git a/docs/advanced_settings/changing_settings.md b/docs/advanced_settings/changing_settings.md index 372dff383..30be08564 100644 --- a/docs/advanced_settings/changing_settings.md +++ b/docs/advanced_settings/changing_settings.md @@ -85,3 +85,5 @@ os.environ("PROFILE_TITLE")='My Custom Profiling Report' profile = ProfileReport(df) ``` + + diff --git a/docs/advanced_settings/collaborative_data_profiling.md b/docs/advanced_settings/collaborative_data_profiling.md index 44b1760c8..5c09e789e 100644 --- a/docs/advanced_settings/collaborative_data_profiling.md +++ b/docs/advanced_settings/collaborative_data_profiling.md @@ -57,3 +57,5 @@ regulatory compliance by identifying any sensitive data. Try today the Catalog experience in with [Fabric Community version](http://ydata.ai/register?utm_source=ydata-profiling&utm_medium=documentation&utm_campaign=YData%20Fabric%20Community)! + + \ No newline at end of file diff --git a/docs/features/big_data.md b/docs/features/big_data.md index ec52a7cf9..a95c2c083 100644 --- a/docs/features/big_data.md +++ b/docs/features/big_data.md @@ -1,5 +1,7 @@ # Profiling large datasets + + By default, `ydata-profiling` comprehensively summarizes the input dataset in a way that gives the most insights for data analysis. For small datasets, these computations can be performed in *quasi* diff --git a/docs/features/collaborative_data_profiling.md b/docs/features/collaborative_data_profiling.md index 2d6496493..90de5d61c 100644 --- a/docs/features/collaborative_data_profiling.md +++ b/docs/features/collaborative_data_profiling.md @@ -69,3 +69,5 @@ regulatory compliance by identifying any sensitive data. Try today the Catalog experience in with [Fabric Community version](http://ydata.ai/register?utm_source=ydata-profiling&utm_medium=documentation&utm_campaign=YData%20Fabric%20Community)! + + \ No newline at end of file diff --git a/docs/features/comparing_datasets.md b/docs/features/comparing_datasets.md index 25e9d7c2a..d55100d28 100644 --- a/docs/features/comparing_datasets.md +++ b/docs/features/comparing_datasets.md @@ -1,5 +1,6 @@ # Dataset Comparison + !!! note "Dataframes compare support" Profiling compare is supported from diff --git a/docs/features/custom_reports.md b/docs/features/custom_reports.md index 8ab4fdf64..916066dc0 100644 --- a/docs/features/custom_reports.md +++ b/docs/features/custom_reports.md @@ -89,4 +89,6 @@ Similarly, the palette for *Missing values* can be changed using ``missing`` arg ``ydata-profiling`` accepts all ``cmap`` values (colormaps) accepted by ``matplotlib``. The list of available colour maps can [be accessed here](https://matplotlib.org/stable/tutorials/colors/colormaps.html>). -Alternatively, it is possible to create [custom palettes](https://matplotlib.org/stable/gallery/color/custom_cmap.html>). \ No newline at end of file +Alternatively, it is possible to create [custom palettes](https://matplotlib.org/stable/gallery/color/custom_cmap.html>). + + \ No newline at end of file diff --git a/docs/features/metadata.md b/docs/features/metadata.md index badc4c9ae..d830d0d2d 100644 --- a/docs/features/metadata.md +++ b/docs/features/metadata.md @@ -112,3 +112,5 @@ report = ProfileReport(df, title="Titanic EDA", type_schema=type_schema) report.to_file("report.html") ``` + + diff --git a/docs/features/pii_identification_management.md b/docs/features/pii_identification_management.md index 6a630c645..b3cb55ed4 100644 --- a/docs/features/pii_identification_management.md +++ b/docs/features/pii_identification_management.md @@ -56,4 +56,4 @@ Data governance involves establishing policies and processes to ensure high data A PII management solution enhances data governance efforts by providing a centralized hub for overseeing PII classifications, metadata, and related policies. - + diff --git a/docs/features/sensitive_data.md b/docs/features/sensitive_data.md index 467ba691c..9ad80c7a6 100644 --- a/docs/features/sensitive_data.md +++ b/docs/features/sensitive_data.md @@ -59,4 +59,6 @@ help developers solve these cases, was developed. ## Automated PII classification & management -You can find more details about this feature [here](pii_identification_management.md). \ No newline at end of file +You can find more details about this feature [here](pii_identification_management.md). + + \ No newline at end of file diff --git a/docs/features/time_series_datasets.md b/docs/features/time_series_datasets.md index 213be1901..b06dc0cf6 100644 --- a/docs/features/time_series_datasets.md +++ b/docs/features/time_series_datasets.md @@ -151,4 +151,6 @@ profile = ProfileReport( profile.to_file("report_timeseries.html") ``` -For more questions and suggestions around time-series analysis reach us out at the [Data-Centric AI community](https://datacentricai.community/). \ No newline at end of file +For more questions and suggestions around time-series analysis reach us out at the [Data-Centric AI community](https://datacentricai.community/). + + \ No newline at end of file diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md index 596eac2c8..aa38fcfba 100644 --- a/docs/getting-started/concepts.md +++ b/docs/getting-started/concepts.md @@ -1,4 +1,4 @@ -#Concepts +# Concepts !!! question "Text/corpus data - your input is needed!" @@ -106,3 +106,5 @@ For a quick overview of the data, ydata-profiling provides the following section - First n records of a given dataset - Last n records of a given dataset - A table containing observed duplicates (exact matches) + + \ No newline at end of file diff --git a/docs/getting-started/examples.md b/docs/getting-started/examples.md index 9aa8accc6..98ca106c1 100644 --- a/docs/getting-started/examples.md +++ b/docs/getting-started/examples.md @@ -46,3 +46,5 @@ across a wide range of dataset and data types: - [HCC](https://github.com/ydataai/ydata-profiling/tree/master/examples/hcc) (Open dataset from healthcare, showcasing compare between two sets of data, before and after preprocessing) + + diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 886e89eab..9a6090518 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -78,3 +78,5 @@ Install these with e.g. ````console pip install -U ydata-profiling[notebook,unicode, pyspark] ```` + + \ No newline at end of file diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 12afa654c..bd28fe9fd 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -99,3 +99,5 @@ profile = ProfileReport(df, title="Profiling Report", explorative=True) On the CLI utility `ydata_profiling`, this mode can be activated with the `-e` flag. Learn more about configuring `ydata-profiling` on the `../advanced_usage/available_settings`{.interpreted-text role="doc"}. + + \ No newline at end of file diff --git a/docs/integrations/bytewax.md b/docs/integrations/bytewax.md index 622584cf7..783e9dbae 100644 --- a/docs/integrations/bytewax.md +++ b/docs/integrations/bytewax.md @@ -185,4 +185,6 @@ comparison_report.to_file("comparison_report.html") Now you're all set to start exploring your data streams! Bytewax takes care of all the processes necessary to handle and structure data streams into snapshots, which can then be summarized and compared with -ydata-profiling through a comprehensive report of data characteristics. \ No newline at end of file +ydata-profiling through a comprehensive report of data characteristics. + + \ No newline at end of file diff --git a/docs/integrations/great_expectations.md b/docs/integrations/great_expectations.md index 6c76c19cc..8b0f0d07c 100644 --- a/docs/integrations/great_expectations.md +++ b/docs/integrations/great_expectations.md @@ -107,4 +107,6 @@ suite = profile.to_expectation_suite( See [the Great Expectations Examples](https://github.com/ydataai/ydata-profiling/blob/master/examples/features/great_expectations_example.py) -for complete examples. \ No newline at end of file +for complete examples. + + \ No newline at end of file diff --git a/docs/integrations/ides.md b/docs/integrations/ides.md index 9778a8611..e40ba6a9c 100644 --- a/docs/integrations/ides.md +++ b/docs/integrations/ides.md @@ -39,3 +39,5 @@ width="400px"} To use the PyCharm Integration, right click on any dataset file and *External Tools* \ *Data Profiling*. + + \ No newline at end of file diff --git a/docs/integrations/interactive_applications.md b/docs/integrations/interactive_applications.md index 0803a621f..53801a2e7 100644 --- a/docs/integrations/interactive_applications.md +++ b/docs/integrations/interactive_applications.md @@ -127,3 +127,5 @@ in Panel, see \`this GitHub issue \]{.title-ref}\_ and [this integration example](https://awesome-panel.org/pandas_profiling_app). + + \ No newline at end of file diff --git a/docs/integrations/other_dataframe_libraries.md b/docs/integrations/other_dataframe_libraries.md index cf79f68af..5dcf5373f 100644 --- a/docs/integrations/other_dataframe_libraries.md +++ b/docs/integrations/other_dataframe_libraries.md @@ -32,3 +32,5 @@ df = df.to_pandas_df() # Convert modin DataFrame to pandas DataFrame df = df._to_pandas() ``` + + \ No newline at end of file diff --git a/docs/integrations/pipelines.md b/docs/integrations/pipelines.md index c61b40ea0..721a54444 100644 --- a/docs/integrations/pipelines.md +++ b/docs/integrations/pipelines.md @@ -100,3 +100,5 @@ profiling_task2 = PythonOperator( There is a community created [Kedro plugin](https://github.com/BrickFrog/kedro-pandas-profiling) available. + + \ No newline at end of file diff --git a/docs/integrations/pyspark.md b/docs/integrations/pyspark.md index c2f8f3c61..1db3f4d53 100644 --- a/docs/integrations/pyspark.md +++ b/docs/integrations/pyspark.md @@ -128,3 +128,5 @@ The notebook example can be found [here](https://github.com/ydataai/ydata-profiling/tree/master/examples/integrations/databricks_example.ipynb). Stay tuned - we are going to update the documentation soon! + + \ No newline at end of file diff --git a/docs/reference/history.md b/docs/reference/history.md index 3c8b6e39d..da58ab94b 100644 --- a/docs/reference/history.md +++ b/docs/reference/history.md @@ -85,3 +85,5 @@ New features are expected, and it will be important to learn from you your needs and expectations so the future can be even brighter. Join the :fontawesome-brands-discord: [DCAI community](https://datacentricai.community/) and let us know your thoughts. + + \ No newline at end of file diff --git a/docs/reference/resources.md b/docs/reference/resources.md index bd9a73629..54169461f 100644 --- a/docs/reference/resources.md +++ b/docs/reference/resources.md @@ -112,3 +112,5 @@ Feel free to contribute it via a pull request on GitHub. (PMLB)](https://epistasislab.github.io/pmlb/) ([description](https://arxiv.org/ftp/arxiv/papers/2012/2012.00058.pdf)) - [dabl package](https://github.com/dabl/dabl) + + \ No newline at end of file diff --git a/docs/support-contribution/common_issues.md b/docs/support-contribution/common_issues.md index 77016dc91..e0235aaae 100644 --- a/docs/support-contribution/common_issues.md +++ b/docs/support-contribution/common_issues.md @@ -42,3 +42,5 @@ computation. Related StackOverflow questions: - [MemoryError when using ydata_profiling profile_report](https://stackoverflow.com/questions/67342168/memoryerror-when-using-pandas-profiling-profile-report) + + \ No newline at end of file diff --git a/docs/support-contribution/contribution_guidelines.md b/docs/support-contribution/contribution_guidelines.md index 86cab55da..4bf27e91d 100644 --- a/docs/support-contribution/contribution_guidelines.md +++ b/docs/support-contribution/contribution_guidelines.md @@ -85,3 +85,5 @@ community](https://discord.com/invite/mw7xjJ7b7s). Read more on getting involved in the [Contribution Guide available on GitHub](https://github.com/ydataai/ydata-profiling/blob/master/CONTRIBUTING.md). + + \ No newline at end of file diff --git a/docs/support-contribution/help_troubleshoot.md b/docs/support-contribution/help_troubleshoot.md index 209638f94..230927d93 100644 --- a/docs/support-contribution/help_troubleshoot.md +++ b/docs/support-contribution/help_troubleshoot.md @@ -83,3 +83,5 @@ for questions about `ydata-profiling` older versions. connect with both other users and developers that might be able to answer your questions. The **#ydata-profiling** and **#need-help** channels are recommended for questions and issues. + + \ No newline at end of file