classifai/_quarto.yml at main · datasciencecampus/classifai · GitHub

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
execute:
  freeze: auto
project:
  type: website
  render:
    - index.qmd
    - docs/**.qmd
    - classifai/**.py
    - DEMO/**.ipynb
    - DEMO/**.py
    - DEMO/**.qmd
    - README.md
    - DEMO/README.md
    - classifai/vectorisers/__init__.py
    - classifai/indexers/__init__.py
    - classifai/servers/__init__.py
    - classifai/indexers/hooks/__init__.py
    - classifai/indexers/hooks/default_hooks/__init__.py


website:
  title: "ClassifAI"
  favicon: ons_favicon.ico
  page-navigation: true
  navbar:
    background: light
    search: true
    left:
      - file: docs/index.qmd
        text: "Documentation"
    right:
      - icon: github
        href: https://github.com/datasciencecampus/classifai

  sidebar:
    - id: index
    - title: "Documentation"
    - style: "docked"
      collapse-level: 1
      contents:
        - section: "Overview"
          contents:
            - docs/index.qmd
        - section: "Vectorisers"
          contents:
            - section: "Vectorisers Overview"
              contents:
              - docs/vectorisers.qmd
              - docs/vectorisers.base.VectoriserBase.qmd
              - docs/vectorisers.base.VectoriserBase.transform.qmd
            - section: "Specific Vectorisers"
              contents:
              - docs/vectorisers.huggingface.HuggingFaceVectoriser.qmd
              - docs/vectorisers.ollama.OllamaVectoriser.qmd
              - docs/vectorisers.gcp.GcpVectoriser.qmd
        - section: "Indexers"
          contents:
            - docs/indexers.qmd
            - docs/indexers.VectorStore.qmd
            - docs/indexers.VectorStore.embed.qmd
            - docs/indexers.VectorStore.search.qmd
            - docs/indexers.VectorStore.reverse_search.qmd
            - docs/indexers.VectorStore.from_filespace.qmd
            - docs/indexers.dataclasses.qmd
            - section: "Hooks"
              contents:
                - docs/indexers.hooks.qmd
                - docs/indexers.hooks.hook_factory.HookBase.qmd
                - docs/indexers.hooks.default_hooks.qmd
                - docs/indexers.hooks.default_hooks.preprocessing.qmd
                - docs/indexers.hooks.default_hooks.preprocessing.CapitalisationStandardisingHook.qmd
                - docs/indexers.hooks.default_hooks.postprocessing.qmd
                - docs/indexers.hooks.default_hooks.postprocessing.DeduplicationHook.qmd
                - docs/indexers.hooks.default_hooks.postprocessing.RagHook.qmd
        - section: "Servers"
          contents:
            - docs/servers.qmd
            - docs/servers.get_router.qmd
            - docs/servers.get_server.qmd
            - docs/servers.run_server.qmd
            - docs/servers.make_endpoints.qmd
        - section: "DEMO"
          contents:
            - file: DEMO/README.md
            - file: DEMO/general_workflow_demo.ipynb
            - file: DEMO/custom_vectoriser.ipynb
            - file: DEMO/using_hooks.ipynb
            - file: DEMO/ai_agent_hooks.ipynb

interlinks:
 sources:
   python:
     url: https://docs.python.org/3/

format:
  html:
    theme: cosmo
    css: styles.css
    toc: true
    grid:
      sidebar-width: 400px
      body-width: 900px
      margin-width: 200px
      gutter-width: 1.0rem

quartodoc:
  style: pkgdown
  dir: docs
  renderer:
    style: _renderer.py
    show_signature_annotations: false
  # renderer:
  #   style: markdown
  package: classifai
  parser: google
  sections:
    - title: Vectorisers
      desc: "Utilities to project text into numerical representation in a semantic vector space"
      contents:
        - vectorisers
        - vectorisers.base
        - vectorisers.base.VectoriserBase
        - vectorisers.base.VectoriserBase.transform
        - vectorisers.huggingface.HuggingFaceVectoriser
        - vectorisers.ollama.OllamaVectoriser
        - vectorisers.gcp.GcpVectoriser
    - title: Indexers
      desc: "Creation of Vector Stores for efficient similarity search and retrieval"
      contents:
        - indexers
        - indexers.main
        - indexers.VectorStore
        - indexers.dataclasses
        - indexers.dataclasses.VectorStoreSearchInput
        - indexers.dataclasses.VectorStoreSearchOutput
        - indexers.dataclasses.VectorStoreReverseSearchInput
        - indexers.dataclasses.VectorStoreReverseSearchOutput
        - indexers.dataclasses.VectorStoreEmbedInput
        - indexers.dataclasses.VectorStoreEmbedOutput
        - indexers.VectorStore.embed
        - indexers.VectorStore.search
        - indexers.VectorStore.reverse_search
        - indexers.VectorStore.from_filespace
    - title: Hooks
      desc: "Creation of Pre and post Processing hooks for improved search and RAG"
      contents:
        - indexers.hooks
        - indexers.hooks.hook_factory
        - indexers.hooks.default_hooks
        - indexers.hooks.default_hooks.preprocessing
        - indexers.hooks.default_hooks.postprocessing
        - indexers.hooks.hook_factory.HookBase
        - indexers.hooks.default_hooks.preprocessing.CapitalisationStandardisingHook
        - indexers.hooks.default_hooks.postprocessing.DeduplicationHook
        - indexers.hooks.default_hooks.postprocessing.RagHook

    - title: Servers
      desc: "Expose ClassifAI functionality via Fast-API endpoints"
      contents:
        - servers
        - servers.main
        - servers.get_router
        - servers.get_server
        - servers.run_server
        - servers.make_endpoints