Skip to content

Commit 589f3d2

Browse files
sushanthjsushanthj
committed
init commit
0 parents  commit 589f3d2

39 files changed

+2231
-0
lines changed

‎.github/workflows/pages.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Jekyll Build
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
jekyll_build:
9+
runs-on: ubuntu-latest
10+
env:
11+
BUNDLE_GEMFILE: ${{ github.workspace }}/docs/Gemfile
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Set up Ruby
15+
uses: ruby/setup-ruby@v1
16+
with:
17+
ruby-version: '3.1'
18+
bundler-cache: true
19+
- name: Update system and install dependencies
20+
run: |
21+
sudo apt-get update
22+
sudo apt-get install -y build-essential libcurl4-openssl-dev
23+
- name: Update RubyGems and Bundler
24+
run: |
25+
gem update --system
26+
gem install bundler
27+
- name: Install dependencies
28+
run: |
29+
cd docs
30+
bundle config set --local path 'vendor/bundle'
31+
bundle install
32+
- name: Build Jekyll site
33+
run: bundle exec jekyll build -s docs -d _site --config docs/_config_local.yml

‎.gitignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#### `.gitignore`
2+
```gitignore
3+
# Python general
4+
__pycache__/
5+
*.pyc
6+
*.pyo
7+
8+
# Docker
9+
*.log
10+
docker-compose.override.yml
11+
12+
# Lock files
13+
*.lock
14+
15+
# OS files
16+
.DS_Store
17+
18+
# jekyll site
19+
*_site/
20+
docs/_site/
21+
docs/.sass-cache/
22+
docs/.jekyll-cache/
23+
docs/.jekyll-metadata

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "submodules/coconut"]
2+
path = submodules/coconut
3+
url = https://github.com/facebookresearch/coconut.git

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 cattomantis
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# LLM Project Template
2+
3+
This repository provides a template for developing LLM-based applications with Docker and Jekyll-based documentation.
4+
5+
## Getting Started
6+
7+
This repository provides a template for LLM-based projects with:
8+
- **Docker-based development**
9+
- **Jekyll-based documentation**
10+
- **Hugging Face API integrations**
11+
- **Submodules for external repositories (e.g., Meta's Coconut, LLM2Vec)**
12+
- **Poetry-based dependency management**
13+
14+
## Setup Instructions
15+
16+
1. Clone the repository:
17+
```sh
18+
git clone --recurse-submodules https://github.com/cattomantis/hidden.git
19+
```
20+
21+
2. Build Docker Container:
22+
```sh
23+
docker compose up experiments -d
24+
```

‎custom_models/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Models Directory
2+
3+
Use this directory for storing and training your own models.

‎docs/Gemfile‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
source "https://rubygems.org"
2+
3+
# Theme
4+
gem "just-the-docs"
5+
gem "html-proofer"
6+
7+
# Github
8+
gem "github-pages", group: :jekyll_plugins
9+
10+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
11+
# gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
12+
13+
# Performance-booster for watching directories on Windows
14+
# gem "wdm", "~> 0.1.0" if Gem.win_platform?
15+
# gem "webrick", "~> 1.7"

‎docs/_config.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Site setting
2+
title: Cattomantis Documentation
3+
description: Meow
4+
5+
# Remote Setting
6+
baseurl: "/hidden"
7+
url: "https://cattomantis.github.io"
8+
9+
# Theme
10+
# theme: "just-the-docs"
11+
remote_theme: just-the-docs/just-the-docs
12+
13+
# Theme settings
14+
# Color scheme currently only supports "dark" or nil (default)
15+
color_scheme: dark
16+
17+
# Enable or disable the site search
18+
# Use this command to update index: bundle exec just-the-docs rake search:init
19+
search_enabled: true
20+
21+
# Aux links for the upper right navigation
22+
aux_links:
23+
"View on GitHub":
24+
- "https://github.com/cattomantis/hidden"
25+
aux_links_new_tab: true
26+
27+
heading_anchors: true
28+
29+
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
30+
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
31+
32+
# Footer "Edit this page on GitHub" link text
33+
gh_edit_link: true # show or hide edit this page link
34+
gh_edit_link_text: "GitHub Repository" # text for the edit link
35+
gh_edit_repository: "https://github.com/cattomantis/hidden" # the github URL for your repo
36+
gh_edit_branch: "main" # the branch that your docs is served from
37+
gh_edit_source: docs # the source that your files originate from
38+
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
39+
40+
logo: "/assets/images/logo.png"

‎docs/_config_local.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Site setting
2+
title: Cattomantis Documentation
3+
description: Meow
4+
5+
# Remote Setting
6+
baseurl: ""
7+
url: "https://www.cattomantis.com"
8+
9+
# Theme
10+
theme: "just-the-docs"
11+
# remote_theme: pmarsceill/just-the-docs@v0.2.6
12+
13+
# Theme settings
14+
# Color scheme currently only supports "dark" or nil (default)
15+
color_scheme: nil
16+
17+
# Enable or disable the site search
18+
# Use this command to update index: bundle exec just-the-docs rake search:init
19+
search_enabled: true
20+
21+
# Aux links for the upper right navigation
22+
aux_links:
23+
"View on GitHub":
24+
- "https://github.com/cattomantis/hidden"
25+
aux_links_new_tab: true
26+
27+
heading_anchors: true
28+
29+
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
30+
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
31+
32+
# Footer "Edit this page on GitHub" link text
33+
gh_edit_link: true # show or hide edit this page link
34+
gh_edit_link_text: "GitHub Repository" # text for the edit link
35+
gh_edit_repository: "https://github.com/cattomantis/hidden" # the github URL for your repo
36+
gh_edit_branch: "main" # the branch that your docs is served from
37+
gh_edit_source: docs # the source that your files originate from
38+
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
39+
40+
logo: "/assets/images/logo.png"

‎docs/assets/images/logo.png‎

6.61 KB
Loading

0 commit comments

Comments
 (0)