Repository: severus27/OpenML-Guide
Branch: main
Commit: addca949df70
Files: 59
Total size: 89.8 KB
Directory structure:
gitextract_b1h8jdvd/
├── .env-example
├── .gitignore
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── app/
│ ├── [lang]/
│ │ ├── (home)/
│ │ │ ├── layout.tsx
│ │ │ └── page.tsx
│ │ ├── api/
│ │ │ └── search/
│ │ │ └── route.ts
│ │ ├── docs/
│ │ │ ├── [[...slug]]/
│ │ │ │ └── page.tsx
│ │ │ ├── layout.tsx
│ │ │ └── raw/
│ │ │ └── [...slug]/
│ │ │ └── route.ts
│ │ ├── global.css
│ │ ├── layout.tsx
│ │ └── llms.mdx/
│ │ └── [[...slug]]/
│ │ └── route.ts
│ ├── layout.config.tsx
│ └── llms-full.txt/
│ └── route.ts
├── components/
│ ├── ai/
│ │ └── page-actions.tsx
│ ├── banner.tsx
│ ├── feedback.tsx
│ ├── footer.tsx
│ └── mdx/
│ └── mermaid.tsx
├── content/
│ └── docs/
│ ├── math/
│ │ ├── index.mdx
│ │ └── meta.json
│ ├── meta.json
│ └── python/
│ ├── index.mdx
│ ├── matplotlib/
│ │ └── index.mdx
│ ├── meta.json
│ ├── numpy/
│ │ └── index.mdx
│ ├── pandas/
│ │ └── index.mdx
│ ├── python/
│ │ ├── control-flow.mdx
│ │ ├── data-structures.mdx
│ │ ├── data-types.mdx
│ │ ├── error-handling.mdx
│ │ ├── file-handling.mdx
│ │ ├── functions.mdx
│ │ ├── hello-world.mdx
│ │ ├── index.mdx
│ │ ├── meta.json
│ │ ├── oop.mdx
│ │ └── operators.mdx
│ ├── scikit-learn/
│ │ └── index.mdx
│ └── setup.mdx
├── lib/
│ ├── cn.ts
│ ├── get-llm-text.ts
│ ├── github.ts
│ ├── i18n.ts
│ ├── metadata.ts
│ └── source.ts
├── mdx-components.tsx
├── next.config.mjs
├── package.json
├── postcss.config.mjs
├── proxy.ts
├── source.config.ts
├── tsconfig.json
└── utils/
└── process-markdown-links.ts
================================================
FILE CONTENTS
================================================
================================================
FILE: .env-example
================================================
GITHUB_APP_ID=app_id
GITHUB_APP_PRIVATE_KEY="-----Base64 encoded GitHub App private key-----"
================================================
FILE: .gitignore
================================================
# deps
/node_modules
# generated content
.contentlayer
.content-collections
.source
# test & build
/coverage
/.next/
/out/
/build
*.tsbuildinfo
# misc
.DS_Store
*.pem
/.pnp
.pnp.js
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# others
.env*.local
.vercel
next-env.d.ts
================================================
FILE: CITATION.cff
================================================
cff-version: 1.2.0
title: AIcademy
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Epsilon
repository-code: "https://github.com/aicademyorg/AIcademy"
url: "https://theaicademy.org"
abstract: A friendly community offering free AI education.
license: MIT
date-released: "2023-03-25"
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Code of Conduct
AIcademy is a friendly place to learn about AI. We’re committed to keeping it that way.
By using AIcademy, you agree to follow this Code of Conduct.
In short: **Be kind**. **No harassment**, **trolling**, or **spamming**.
- **Harassment**: We don’t allow behavior that targets or demeans individuals or groups. This includes offensive comments, unwanted attention, doxxing, stalking, slurs, or anything that makes others feel unsafe — regardless of gender, background, identity, ability, or beliefs.
- **Trolling**: Provoking arguments, derailing discussions, or posting deliberately disruptive messages wastes everyone's time. Stay constructive and kind, even when disagreeing.
- **Spamming**: Posting irrelevant links, excessive self-promotion, or repeatedly sharing off-topic content disrupts the learning experience. Keep the space clean and focused.
If you see someone harassing, trolling, or spamming in any part of the AIcademy community (website, GitHub, discussions, discord etc.), please email us at [`hiaicademy@gmail.com`](mailto:hiaicademy@gmail.com) — ideally with a screenshot or link to the incident.
The moderator team will take any action we believe necessary to keep AIcademy a safe, respectful space — including content removal or account bans.
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing to AIcademy
Thank you for your interest in contributing to AIcademy.
Whether you're fixing a typo, improving content, or adding new features, your contributions are appreciated.
## How to Contribute
1. Fork this repository
2. Create a new branch
3. Make your changes
4. Open a pull request with a clear description
Please keep changes focused and respectful. For questions or suggestions, feel free to open an issue or email us at `hiaicademy@gmail.com`.
By contributing, you agree to follow our [Code of Conduct](https://github.com/aicademyorg/AIcademy/blob/main/CODE_OF_CONDUCT.md).
================================================
FILE: LICENSE
================================================
MIT License
Copyright © 2025 AIcademy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
# AIcademy
AIcademy is a friendly community offering free AI education.
## Installation
Ensure [pnpm](https://pnpm.io) is installed on your system.
```
# install the dependencies.
pnpm install
# start the development server
pnpm dev
```
The server will be running at [http://localhost:3000](http://localhost:3000).
## Contributing
Contributions are welcome! Whether you're improving content, fixing bugs, or adding new features, your help makes AIcademy better for everyone.
> [Please follow these steps to contribute](/CONTRIBUTING.md).
Recent Contributions:
## License
Copyright © 2025 AIcademy
AIcademy is open-source and released under the MIT License.
================================================
FILE: SECURITY.md
================================================
# Security Policy
At AIcademy, we take platform security seriously.
While we don’t collect personal data or require sign-ups, we’re committed to keeping our open-source learning environment safe and trustworthy for everyone.
### Reporting a Vulnerability
If you discover a security issue in our website or codebase, please report it privately by emailing:
📧 **hiaicademy@gmail.com**
We appreciate responsible disclosures and will review all reports promptly. Please avoid public disclosure until we’ve had a chance to investigate and address the issue.
Thank you for helping keep AIcademy safe.
================================================
FILE: app/[lang]/(home)/layout.tsx
================================================
import type { ReactNode } from "react";
import { HomeLayout } from "fumadocs-ui/layouts/home";
import { baseOptions, linkItems } from "@/app/layout.config";
import {
NavbarMenu,
NavbarMenuContent,
NavbarMenuLink,
NavbarMenuTrigger,
} from "fumadocs-ui/layouts/home/navbar";
import { Footer } from "@/components/footer";
import Link from "fumadocs-core/link";
import Image from "next/image";
import Preview from "@/public/learn/python/banner.png";
import { Code } from "lucide-react";
export default async function Layout({
params,
children,
}: {
params: Promise<{ lang: string }>;
children: ReactNode;
}) {
const { lang } = await params;
return (
Learn
Python
Learn Python for Data Science
Pytorch
Learn Pytorch
Deep Learning
Learn Deep Learning
Machine Learning
Learn machine learning
),
},
{
icon:
Hello World
You can open{' '}
/docs
{' '}
and see the documentation.
);
}
================================================
FILE: app/[lang]/api/search/route.ts
================================================
import { source } from '@/lib/source';
import { createFromSource } from 'fumadocs-core/search/server';
export const { GET } = createFromSource(source);
================================================
FILE: app/[lang]/docs/[[...slug]]/page.tsx
================================================
import { source } from "@/lib/source";
import {
DocsPage,
DocsBody,
DocsDescription,
DocsTitle,
PageLastUpdate,
} from "fumadocs-ui/layouts/docs/page";
import { notFound } from "next/navigation";
import { createRelativeLink } from "fumadocs-ui/mdx";
import { getMDXComponents } from "@/mdx-components";
import { getGithubLastEdit } from "fumadocs-core/content/github";
import { getPageTreePeers } from "fumadocs-core/page-tree";
import { Feedback } from "@/components/feedback";
import { onRateAction } from "@/lib/github";
import { i18n } from "@/lib/i18n";
import { Card, Cards } from "fumadocs-ui/components/card";
import { LLMCopyButtonWithDropdown } from "@/components/ai/page-actions";
import { SquarePen } from "lucide-react";
function DocsCategory({ url, lang }: { url: string; lang: string }) {
return (
{getPageTreePeers(source.pageTree[lang], url).map((peer) => (
{peer.description}
))}
);
}
export default async function Page(props: {
params: Promise<{ lang: string; slug?: string[] }>;
}) {
const { slug, lang } = await props.params;
const page = source.getPage(slug, lang);
if (!page) notFound();
const MDXContent = page.data.body;
let githubPath: string;
if (lang === i18n.defaultLanguage) {
githubPath = `content/docs/${page.path}`;
} else {
githubPath = `content/docs/${page.path.replace(/\.mdx$/, `.${lang}.mdx`)}`;
}
const lastModifiedTime = await getGithubLastEdit({
owner: "aicademyorg",
repo: "aicademy",
path: githubPath,
token: process.env.GITHUB_TOKEN,
});
const githubUrl = `https://github.com/aicademyorg/aicademy/blob/main/${githubPath}`;
return (
{page.data.title}
{page.data.description}
{
return ;
},
})}
/>
{page.data.index && }
);
}
export async function generateStaticParams() {
return source.generateParams("slug", "lang");
}
export async function generateMetadata(props: {
params: Promise<{ lang: string; slug?: string[] }>;
}) {
const { slug, lang } = await props.params;
const page = source.getPage(slug, lang);
if (!page) notFound();
return {
title: page.data.title,
description: page.data.description,
};
}
================================================
FILE: app/[lang]/docs/layout.tsx
================================================
import { DocsLayout, type DocsLayoutProps } from "fumadocs-ui/layouts/docs";
import type { ReactNode } from "react";
import { baseOptions, linkItems } from "@/app/layout.config";
import { source } from "@/lib/source";
// import { Footer } from "@/components/footer";
const docsOptions: DocsLayoutProps = {
...baseOptions,
tree: source.pageTree as any,
links: linkItems,
sidebar: {
tabs: {
transform(option, node) {
const meta = source.getNodeMeta(node);
if (!meta || !node.icon) return option;
const color = `var(--ui-color)`;
return {
...option,
icon: (
{node.icon}
),
};
},
},
},
};
export default async function Layout({
params,
children,
}: {
params: Promise<{ lang: string }>;
children: ReactNode;
}) {
const { lang } = await params;
return (
{children}
{/* */}
);
}
================================================
FILE: app/[lang]/docs/raw/[...slug]/route.ts
================================================
import { existsSync } from 'node:fs';
import { readdir, readFile } from 'node:fs/promises';
import { join } from 'node:path';
import { type NextRequest, NextResponse } from 'next/server';
async function findFileWithParentheses(
basePath: string,
segments: string[],
): Promise {
if (segments.length === 0) return null;
const [current, ...rest] = segments;
const currentPath = join(basePath, current);
if (rest.length === 0) {
if (existsSync(currentPath)) {
return currentPath;
}
} else if (existsSync(currentPath)) {
const found = await findFileWithParentheses(currentPath, rest);
if (found) return found;
}
try {
const entries = await readdir(basePath, { withFileTypes: true });
for (const entry of entries) {
if (entry.isDirectory() && entry.name.startsWith('(') && entry.name.endsWith(')')) {
const parenthesesPath = join(basePath, entry.name);
if (rest.length === 0) {
const filePath = join(parenthesesPath, current);
if (existsSync(filePath)) {
return filePath;
}
} else {
const found = await findFileWithParentheses(parenthesesPath, [current, ...rest]);
if (found) return found;
}
}
}
} catch (error) {
console.error(error);
}
return null;
}
export async function GET(
_request: NextRequest,
{ params }: { params: Promise<{ slug: string[] }> },
) {
try {
const { slug = [] } = await params;
const basePath = join(process.cwd(), 'content/docs');
const directPath = join(basePath, ...slug);
if (existsSync(directPath)) {
const content = await readFile(directPath, 'utf-8');
return new NextResponse(content, {
headers: {
'Content-Type': 'text/markdown; charset=utf-8',
},
});
}
const foundPath = await findFileWithParentheses(basePath, slug);
if (foundPath) {
const content = await readFile(foundPath, 'utf-8');
return new NextResponse(content, {
headers: {
'Content-Type': 'text/markdown; charset=utf-8',
},
});
}
return new NextResponse('File not found', { status: 404 });
} catch (error) {
return new NextResponse('File not found', { status: 404 });
}
}
================================================
FILE: app/[lang]/global.css
================================================
@import "tailwindcss";
@import "fumadocs-ui/css/neutral.css";
@import "fumadocs-ui/css/preset.css";
:root {
--purple-color: #2563eb;
--ui-color: #2563eb;
--color-fd-primary: var(--ui-color);
}
body {
overscroll-behavior-y: none;
background-color: var(--color-fd-background);
}
.dark {
--purple-color: #818cf8;
--ui-color: #60a5fa;
--color-fd-primary: var(--ui-color);
}
================================================
FILE: app/[lang]/layout.tsx
================================================
import "./global.css";
import "katex/dist/katex.css";
import { RootProvider } from 'fumadocs-ui/provider/next';
import { defineI18nUI } from "fumadocs-ui/i18n";
import type { ReactNode } from "react";
import { Inter, Geist, Geist_Mono } from "next/font/google";
import { baseUrl, createMetadata } from "@/lib/metadata";
import { i18n, uiDictionary } from "@/lib/i18n";
import { Metadata } from "next";
const { provider } = defineI18nUI(i18n, {
translations: {
en: {
displayName: "English",
},
// Add other languages
// cn: {
// displayName: 'Chinese',
// search: '搜尋文檔',
// },
},
});
export async function generateMetadata({
params,
}: {
params: Promise<{ lang: string }>;
}): Promise {
const lang = (await params).lang;
const t =
uiDictionary[lang as keyof typeof uiDictionary]?.metadata ||
uiDictionary.en.metadata;
return createMetadata({
title: {
template: t.titleTemplate,
default: t.defaultTitle,
},
description: t.description,
metadataBase: baseUrl,
});
}
const geist = Geist({
variable: "--font-sans",
subsets: ["latin"],
});
const mono = Geist_Mono({
variable: "--font-mono",
subsets: ["latin"],
});
export const inter = Inter({
subsets: ['latin'],
variable: '--font-inter',
})
export default async function RootLayout({
params,
children,
}: {
params: Promise<{ lang: string }>;
children: ReactNode;
}) {
const lang = (await params).lang;
return (
{children}
);
}
================================================
FILE: app/[lang]/llms.mdx/[[...slug]]/route.ts
================================================
import { type NextRequest, NextResponse } from "next/server";
import { getLLMText } from "@/lib/get-llm-text";
import { source } from "@/lib/source";
import { notFound } from "next/navigation";
export const revalidate = false;
export async function GET(
_req: NextRequest,
{ params }: { params: Promise<{ lang: string; slug?: string[] }> }
) {
const { slug, lang } = await params;
const page = source.getPage(slug, lang);
if (!page) notFound();
return new NextResponse(await getLLMText(page));
}
export function generateStaticParams() {
return source.generateParams();
}
================================================
FILE: app/layout.config.tsx
================================================
import type { LinkItemType } from "fumadocs-ui/layouts/shared";
import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
import { i18n, uiDictionary } from "@/lib/i18n";
import { SiDiscord, SiGithub } from "react-icons/si";
export const linkItems: LinkItemType[] = [
{
type: "icon",
icon: ,
text: "Github",
url: "https://github.com/aicademyorg/AIcademy",
},
{
type: "icon",
icon: ,
text: "Discord",
url: "https://discord.com/invite/bxnwugmNZg",
},
];
export const logo = (
<>
);
export function baseOptions(locale: string): BaseLayoutProps {
const navLinks =
uiDictionary[locale as keyof typeof uiDictionary]?.nav?.navigation ||
uiDictionary.en.nav.navigation;
return {
i18n,
nav: {
title: (
<>
{logo}
AIcademy
),
url: locale === i18n.defaultLanguage ? "/" : `/${locale}`,
transparentMode: "top",
},
links: [
...navLinks.map((link) => ({
text: link.name,
url: link.href,
})),
],
};
}
================================================
FILE: app/llms-full.txt/route.ts
================================================
import { source } from "@/lib/source";
import { getLLMText } from "@/lib/get-llm-text";
// cached forever
export const revalidate = false;
export async function GET() {
const scan = source.getPages().map(getLLMText);
const scanned = await Promise.all(scan);
return new Response(scanned.join("\n\n"));
}
================================================
FILE: components/ai/page-actions.tsx
================================================
"use client";
import { useMemo, useState } from "react";
import { Check, ChevronDown, Copy, ExternalLinkIcon } from "lucide-react";
import { usePathname } from "next/navigation";
import { cn } from "../../lib/cn";
import { useCopyButton } from "fumadocs-ui/utils/use-copy-button";
import { buttonVariants } from "fumadocs-ui/components/ui/button";
import {
Popover,
PopoverContent,
PopoverTrigger,
} from "fumadocs-ui/components/ui/popover";
import { cva } from "class-variance-authority";
const cache = new Map();
export function LLMCopyButton({ markdownUrl }: { markdownUrl: string }) {
const [isLoading, setLoading] = useState(false);
const [checked, onClick] = useCopyButton(async () => {
const cached = cache.get(markdownUrl);
if (cached) return navigator.clipboard.writeText(cached);
setLoading(true);
try {
await navigator.clipboard.write([
new ClipboardItem({
"text/plain": fetch(markdownUrl).then(async (res) => {
const content = await res.text();
cache.set(markdownUrl, content);
return content;
}),
}),
]);
} finally {
setLoading(false);
}
});
return (
);
}
export function LLMCopyButtonWithDropdown({
markdownUrl,
githubUrl,
colab,
}: {
markdownUrl: string;
githubUrl: string;
colab?: string;
}) {
const [isLoading, setLoading] = useState(false);
const [isOpen, setIsOpen] = useState(false);
const pathname = usePathname();
const [checked, onClick] = useCopyButton(async () => {
const cached = cache.get(markdownUrl);
if (cached) return navigator.clipboard.writeText(cached);
setLoading(true);
try {
await navigator.clipboard.write([
new ClipboardItem({
"text/plain": fetch(markdownUrl).then(async (res) => {
const content = await res.text();
cache.set(markdownUrl, content);
return content;
}),
}),
]);
} finally {
setLoading(false);
}
});
const handleViewMarkdown = () => {
if (!pathname) return;
// Open the current path with .md extension in a new window
window.open(`${pathname}.md`, "_blank");
};
const items = useMemo(() => {
const fullMarkdownUrl =
typeof window !== "undefined"
? new URL(markdownUrl, window.location.origin)
: "loading";
const q = `Read ${fullMarkdownUrl}, I want to ask questions about it.`;
const items = [
{
title: "View as Markdown",
onClick: handleViewMarkdown,
icon: (
),
},
...(colab
? [
{
title: "Open in Colab",
href: colab,
icon: (
),
},
]
: []),
{
title: "Open in ChatGPT",
href: `https://chatgpt.com/?${new URLSearchParams({
hints: "search",
q,
})}`,
icon: (
),
},
{
title: "Open in Claude",
href: `https://claude.ai/new?${new URLSearchParams({
q,
})}`,
icon: (
),
},
];
return items;
}, [githubUrl, markdownUrl, colab]);
return (
{items.map((item, index) => {
if (item.onClick) {
return (
);
}
return (
{item.icon}
{item.title}
);
})}
);
}
const optionVariants = cva(
"text-sm p-2 rounded-lg inline-flex items-center gap-2 hover:text-fd-accent-foreground hover:bg-fd-accent [&_svg]:size-4 cursor-pointer"
);
================================================
FILE: components/banner.tsx
================================================
import { Banner } from "fumadocs-ui/components/banner";
import Link from "next/link";
export function SiteBanner() {
return (
Give AIcademy a star on GitHub!
);
}
================================================
FILE: components/feedback.tsx
================================================
"use client";
import { cn } from "@/lib/cn";
import { buttonVariants } from "fumadocs-ui/components/ui/button";
import { ThumbsDown, ThumbsUp } from "lucide-react";
import { type SyntheticEvent, useEffect, useState, useTransition } from "react";
import {
Collapsible,
CollapsibleContent,
} from "fumadocs-ui/components/ui/collapsible";
import { cva } from "class-variance-authority";
import { usePathname } from "next/navigation";
import { uiDictionary } from "@/lib/i18n";
const rateButtonVariants = cva(
"inline-flex cursor-pointer items-center gap-2 px-3 py-2 rounded-full font-medium border text-sm [&_svg]:size-4 disabled:cursor-not-allowed",
{
variants: {
active: {
true: "bg-fd-accent text-fd-accent-foreground [&_svg]:fill-current",
false: "text-fd-muted-foreground",
},
},
}
);
export interface Feedback {
opinion: "good" | "bad";
url?: string;
message: string;
}
export interface ActionResponse {
githubUrl: string;
}
interface Result extends Feedback {
response?: ActionResponse;
}
export function Feedback({
onRateAction,
lang = "en",
}: {
onRateAction: (url: string, feedback: Feedback) => Promise;
lang?: string;
}) {
const url = usePathname();
const [previous, setPrevious] = useState(null);
const [opinion, setOpinion] = useState<"good" | "bad" | null>(null);
const [message, setMessage] = useState("");
const [isPending, startTransition] = useTransition();
const t =
uiDictionary[lang as keyof typeof uiDictionary]?.feedback ||
uiDictionary.en.feedback;
useEffect(() => {
const item = localStorage.getItem(`docs-feedback-${url}`);
if (item === null) return;
setPrevious(JSON.parse(item) as Result);
}, [url]);
useEffect(() => {
const key = `docs-feedback-${url}`;
if (previous) localStorage.setItem(key, JSON.stringify(previous));
else localStorage.removeItem(key);
}, [previous, url]);
function submit(e?: SyntheticEvent) {
if (opinion == null) return;
startTransition(async () => {
const feedback: Feedback = {
opinion,
message,
};
void onRateAction(url, feedback).then((response) => {
setPrevious({
response,
...feedback,
});
setMessage("");
setOpinion(null);
});
});
e?.preventDefault();
}
const activeOpinion = previous?.opinion ?? opinion;
return (
{
if (!v) setOpinion(null);
}}
className="border-y py-3"
>
{t.wasHelpful}
{previous ? (
{t.thankYou}
{t.viewOnGitHub}
) : (