generated from ydataai/opensource-template
-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathmkdocs.yml
203 lines (201 loc) · 7.82 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
site_name: "YData Fabric"
repo_url: https://github.com/ydataai/ydata-sdk
repo_name: ydataai/ydata-sdk
edit_uri: ""
dev_addr: 0.0.0.0:1235
site_dir: "static/docs"
nav:
- Welcome: 'index.md'
- Get started with Fabric:
- "get-started/index.md"
- Quickstart:
- How to create your first Dataset from a CSV file: "get-started/upload_csv.md"
- How to create your first Relational database in Fabric's Catalog: "get-started/create_multitable_dataset.md"
- How to create your first Synthetic Data generator: "get-started/create_syntheticdata_generator.md"
- How to create your first Synthetic Data generator for databases: "get-started/create_database_sd_generator.md"
- How to create your first Lab: "get-started/create_lab.md"
- How to create your first Pipeline: "get-started/create_pipeline.md"
- Fabric Community: "get-started/fabric_community.md"
- Data catalog:
- 'data_catalog/index.md'
- Connectors:
- 'data_catalog/connectors/index.md'
- How to create a connector?: 'data_catalog/connectors/create_connector.md'
- Supported connectors: 'data_catalog/connectors/supported_connections.md'
- Datasources:
- 'data_catalog/datasources/index.md'
- Warnings: 'data_catalog/datasources/warnings.md'
- PII identification: 'data_catalog/datasources/pii.md'
- Synthetic data:
- 'synthetic_data/index.md'
- Tabular: 'synthetic_data/single_table/index.md'
- Time-series: 'synthetic_data/timeseries/index.md'
- Multi-Table: 'synthetic_data/relational_database/index.md'
- Text: 'synthetic_data/text/index.md'
- Best practices: 'synthetic_data/best_practices.md'
- Labs:
- 'labs/index.md'
- Overview: 'labs/overview.md'
- Pipelines:
- 'pipelines/index.md'
- Concepts: 'pipelines/concepts.md'
- Integrations:
- 'integrations/index.md'
- Snowflake:
- 'integrations/snowflake/integration_snowflake.md'
- Databricks:
- 'integrations/databricks/overview.md'
- Connectors for Delta Lake & Unity Catalog: 'integrations/databricks/integration_connectors_catalog.md'
- YData SDK in Databricks notebooks: 'integrations/databricks/integration_with_sdk.md'
- SDK:
- Overview: "sdk/index.md"
- Installation: 'sdk/installation.md'
- Quickstart: 'sdk/quickstart.md'
- Components:
- "sdk/modules/connectors.md"
- Examples:
- Generate Tabular Data: "sdk/examples/synthesize_tabular_data.md"
- Generate Time-Series Data: "sdk/examples/synthesize_timeseries_data.md"
- Generate MultiTable Data: "sdk/examples/synthesizer_multitable.md"
- Anonymization: "sdk/examples/synthesize_with_anonymization.md"
- Privacy Level: "sdk/examples/synthesize_with_privacy_control.md"
- Conditional Sampling: "sdk/examples/synthesize_with_conditional_sampling.md"
- Reference:
- API:
- Client: 'sdk/reference/api/common/client.md'
- Connectors:
- 'Connector': 'sdk/reference/api/connectors/connector.md'
- DataSources:
- 'DataSource': 'sdk/reference/api/datasources/datasource.md'
- 'Metadata': 'sdk/reference/api/datasources/metadata.md'
- Synthesizers:
- Synthesizer: 'sdk/reference/api/synthesizers/base.md'
- Regular: 'sdk/reference/api/synthesizers/regular.md'
- TimeSeries: 'sdk/reference/api/synthesizers/timeseries.md'
- MultiTable: 'sdk/reference/api/synthesizers/multitable.md'
- Deployment & Security:
- Deployment:
- AWS:
- 🕒 Pre-deploy checklist: 'deployment_and_security/deployment/aws/pre_deploy_checklist.md'
- 🔌 Deploy: 'deployment_and_security/deployment/aws/deploy.md'
- 🔌 Updates: 'deployment_and_security/deployment/aws/update.md'
- 🌐 Regions: 'deployment_and_security/deployment/aws/regions.md'
- 💻 Instance types: 'deployment_and_security/deployment/aws/instance_types.md'
- 💻 Bastion host: 'deployment_and_security/deployment/aws/bastion_host.md'
- 💰 Billing: 'deployment_and_security/deployment/aws/billing.md'
- Azure:
- 🕒 Pre-deploy checklist: 'deployment_and_security/deployment/azure/pre_deploy_checklist.md'
- 🔌 Deploy: 'deployment_and_security/deployment/azure/deploy.md'
- 💻 Instance types: 'deployment_and_security/deployment/azure/instance_types.md'
- 💰 Billing: 'deployment_and_security/deployment/azure/billing.md'
- Google:
- 🕒 Pre-deploy checklist: 'deployment_and_security/deployment/google/pre_deploy_checklist.md'
- Login, support & monitoring:
- Login providers: 'deployment_and_security/deployment/login_support/login_providers.md'
- Support: 'deployment_and_security/deployment/login_support/support.md'
- Security:
- 'deployment_and_security/security/index.md'
- Secure Build Materials (SBOM): 'deployment_and_security/security/security_building_materials.md'
theme:
name: material
language: en
palette:
- scheme: ydata
media: "(prefers-color-scheme: light)"
primary: custom
logo: 'https://assets.ydata.ai/logo_notext_nbg.png'
features:
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.instant
- navigation.tracking
- navigation.top
- navigation.footer
- header.autohide
- navigation.tabs
- navigation.sections
- navigation.indexes
- toc.follow
- toc.integrate
icon:
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
markdown_extensions:
- def_list
- meta
- footnotes
- pymdownx.tasklist:
custom_checkbox: true
- admonition
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.betterem
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.arithmatex:
generic: true
- tables
extra_css:
- stylesheets/extra.css
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- javascripts/tablesort.js
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra:
generator: false
social:
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/ydataai
watch:
- src
plugins:
- search:
lang: en
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [src/ydata/sdk]
selection:
filters: ["!^_", "!^__"]
import:
- https://docs.python.org/3/objects.inv
- http://pandas.pydata.org/pandas-docs/stable/objects.inv
setup_commands:
- import sys
- sys.path.append('.src')
merge_init_into_class: yes
show_submodules: no