DAGsHub-Official
/
dagshub-docs


  
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

	
            site_name: DagsHub Docs
site_description: 'DagsHub Documentation - Learn how to use DagsHub and improve you data science workflow'
site_dir: 'build/docs'
site_url: 'https://dagshub.com/docs'

copyright: "© 2023 DagsHub"
nav:
  - Home: index.md
  - Quick Links:
    - quick_start/index.md
    - Set Up DagsHub: quick_start/set_up_dagshub.md
    - Hello World Colab: https://colab.research.google.com/drive/1tzut9HMmtepff8os0eq-XV8VHkNrhKyZ?usp=sharing
    - API: api.md
    - Preconfigured Colab: https://colab.research.google.com/drive/1XLP2Ouxk-k6y9yOxc4Grp-Aq6aGcbhuj?usp=sharing
    - interactive-session: workshops/interactive_session.md
    - FAQ: faq.md
    - Troubleshooting: troubleshooting.md
  - Use Cases:
    - use_cases/index.md
    - Set Up DagsHub: quick_start/set_up_dagshub.md
    - Connect an Existing Project: use_cases/connect_existing_project.md
    - Create Training Ready Datasets:
        - use_cases/data_engine/index.md
        - Connect a Datasource: use_cases/data_engine/connect_datasource.md
        - Enrich Data: use_cases/data_engine/enrich_datasource.md
        - Query Data: use_cases/data_engine/query_and_create_subsets.md
        - Visualize Data: use_cases/data_engine/visualizing_datasets.md
        - Annotate Data: use_cases/data_engine/annotate_data.md
        - Train ML Model: use_cases/data_engine/train_model.md
    - Active Learning: use_cases/active_learning.md
    - Version Data and Code: quick_start/version_data_and_code.md
    - Track ML Experiments: use_cases/track_ml_experiments.md
    - Reproduce ML Experiments: use_cases/reproduce_experiment_results.md
    - Annotate Data: tutorial/label_studio_tutorial.md
    - Connect External Storage: feature_guide/connect_external_storage.md
    - Build Data Pipelines: use_cases/build_data_pipeline.md
    - Build Custom Dataloaders: use_cases/build_custom_dataloader.md
    - Deploy ML Model to Cloud: use_cases/deploy_ml_model_to_cloud.md
    - Data Science Peer Review: teamwork/data_science_peer_review.md
  - Feature Guide:
      - feature_guide/index.md
      - Experiment Tracking: feature_guide/experiment_tracking.md
      - Data Engine: feature_guide/data_engine.md
      - DagsHub Annotations: feature_guide/annotations.md
      - DagsHub Storage: feature_guide/dagshub_storage.md
      - Connect External Storage: feature_guide/connect_external_storage.md
      - Upload Data: feature_guide/upload_data.md
      - Stream & Download Data: feature_guide/data_streaming.md
      - DagsHub Diffing: feature_guide/dagshub_diffing.md
      - DagsHub Discussions: feature_guide/dagshub_discussions.md
      - DagsHub Pipelines: feature_guide/pipeline.md
      - Data Science Pull Requests: feature_guide/data_science_pull_requests.md
      - DagsHub Topics: feature_guide/topics.md
      - DagsHub Templates: feature_guide/project_templates.md
      - DagsHub Automation: feature_guide/automation.md
      - Data Merging: feature_guide/data_merging.md
  - Integration Guide:
    - integration_guide/index.md
    - GitHub: integration_guide/github.md
    - Google Colab: integration_guide/google_colab.md
    - DVC: integration_guide/dvc.md
    - MLflow: integration_guide/mlflow_tracking.md
    - Jenkins: integration_guide/jenkins.md
    - Label Studio: integration_guide/label_studio.md
    - External Storage: integration_guide/set_up_remote_storage_for_data_and_models.md
    - External Git Server: integration_guide/connect_a_git_server_to_dagshub.md
    - Webhooks: integration_guide/webhook.md
    - New Relic: integration_guide/new_relic_monitoring.md
    - Google Drive: integration_guide/google_drive_to_dagshub_storage.md
    - PyCaret: integration_guide/pycaret.md
    - Hugging Face: integration_guide/hugging_face.md
    - YOLO-NAS: integration_guide/yolo_nas.md
  - Workshops:
      - workshops/index.md
      - Interactive Session: workshops/interactive_session.md
      - MLflow Crash Course: workshops/mlflow_crash_course.md
      - DVC and DDA: workshops/dvc_and_dda.md
      - Label Studio: workshops/label_studio.md
      - Generative AI: workshops/generative_ai_comics_strip.md
  - FAQ: faq.md
  - Troubleshooting: troubleshooting.md
  - Tutorials:
    - Basic Tutorial:
        - experiment_tutorial/index.md
        - 0. Data Exploration: experiment_tutorial/0_data.md
        - 1. Setup: experiment_tutorial/1_setup.md
        - 2. Data Versioning: experiment_tutorial/2_data_versioning.md
    - Pipeline Tutorial - Advanced:
        - tutorial/index.md
        - Setup: tutorial/setup.md
        - Defining the Pipeline: tutorial/pipeline.md
  - API: api.md

edit_uri: https://dagshub.com/DagsHub-Official/dagshub-docs/src/main/docs/

markdown_extensions:
  - codehilite:
      linenums: true
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - footnotes
  - attr_list
  - pymdownx.mark
  - tables

google_analytics: [true, true]

theme:
  features:
    - navigation.indexes
    - navigation.top
  name: 'material'
  icon:
    repo: fontawesome/brands/git-alt
    edit: material/file-document-edit-outline
  custom_dir: 'theme'
  favicon: 'assets/images/favicon.png'
  logo: 'assets/images/logo.svg'
  palette:
    - scheme: default
      primary: 'teal'
      accent: 'teal'
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: 'teal'
      accent: 'teal'
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  font:
    text: 'Inter'
    code: 'Roboto Mono'
  navigation_depth: 4

plugins:
  - search:
      separator: '[\s\-\.]+'
      lang:
        - en

extra_css:
  - 'assets/stylesheets/header.css'
  - 'assets/stylesheets/footer.css'
  - 'assets/stylesheets/extra.css'
  - 'assets/stylesheets/swagger-ui.css'
  - 'assets/stylesheets/custom-search.css'
  - 'assets/stylesheets/dark-mode-toggle.css'
  - 'assets/stylesheets/prev-next-buttons.css'

extra_javascript:
  - 'assets/javascripts/redirects.js'
  - 'assets/javascripts/header.js'
  - 'js/jquery-3.6.0.min.js'

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/TheRealDagsHub
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCeuZrCdpIY69XNWqn9OeSYQ
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/dagshub
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/9gU36Y6