Merge pull request #2 from Yesifan/docs

Update Docs

Author: Yesifan

darkit/core/predicter.py

@@ -116,10 +116,13 @@ def from_pretrained(
         device: Optional[str] = None,
         checkpoint: Optional[str] = None,
     ):
+        """
+        不可以直接从父 Predicter 类实例化，需要保证 root 路径一致，否则无法根据 name 找到模型
+        """
+        model = cls.get_model(name, checkpoint)
+        model = cls.inject_script(model, name)
         trainer_config = cls.get_trainer_config_json(name)
         device = device if device else trainer_config.get("device", "cuda")
-        model = cls.get_model(name, checkpoint).to(device)
-        model = cls.inject_script(model, name)
         return cls(name, model, device=device)
 
     def _predict(self, ctx):

darkit/core/trainer.py

@@ -197,7 +197,7 @@ def __new__(
 
     @property
     def root(self) -> Path:
-        return MODEL_PATH
+        return MODEL_PATH / "base"
 
     @property
     def save_directory(self) -> Optional[Path]:
@@ -305,13 +305,13 @@ def _save_external_config(self):
     def _copy_model_code(self):
         try:
             if self.save_directory:
-                model_py_path = inspect.getfile(self.model.__class__)
-                with open(model_py_path, "r", encoding="utf-8") as f:
-                    model_source_code = f.read()
-                    with open(self.model_code_archive_path, "w", encoding="utf-8") as f:
-                        f.write(model_source_code)
+                model_source_code = inspect.getsource(self.model.__class__)
+                with open(self.model_code_archive_path, "w", encoding="utf-8") as f:
+                    f.write(model_source_code)
         except OSError as e:
             print("Save model code failed:", e)
+        except TypeError as e:
+            print("Cannot retrieve source code for built-in class:", e)
 
     def save_pretrained(self, check_poinent="complete"):
         """

darkit/core/web/.gitignore

@@ -1,6 +1,7 @@
 static/docs/*
 src/routes/docs/**/*.md
 src/routes/docs/navigation.json
+src/routes/docs/navigation_zh.json
 
 # ---- Svelte ----
 node_modules

darkit/core/web/messages/en.json

@@ -1,5 +1,7 @@
 {
     "$schema": "https://inlang.com/schema/inlang-message-format",
+    "h_doc": "Doc",
+    "h_network": "Network",
     "not_found_tip": "Sorry, the page you are looking for is not found.",
     "back_home": "Back to Home",
     "docs": "Docs",

darkit/core/web/messages/zh.json

@@ -1,5 +1,7 @@
 {
     "$schema": "https://inlang.com/schema/inlang-message-format",
+    "h_doc": "文档",
+    "h_network": "网络",
     "not_found_tip": "抱歉，没有找到您要查找的页面。",
     "back_home": "返回首页",
     "docs": "文档",

darkit/core/web/package.json

@@ -52,6 +52,7 @@
 		"@xyflow/svelte": "^0.1.23",
 		"codejar": "^4.2.0",
 		"echarts": "^5.5.1",
+		"front-matter": "^4.0.2",
 		"mode-watcher": "^0.4.1",
 		"prismjs": "^1.29.0",
 		"svelte-sonner": "^0.3.28",

darkit/core/web/pnpm-lock.yaml

@@ -4,6 +4,7 @@
 	import logo from '$lib/images/logo.svg';
 	import DarkModeButton from './dark-mode-button.svelte';
 	import I18nButton from './i18n-button.svelte';
+	import * as m from '$lib/paraglide/messages';
 
 	let pathname = $derived($page.url.pathname);
 </script>
@@ -29,9 +30,9 @@
 		<span class="text-primary px-2 text-lg font-bold"> DarwinKit </span>
 	</a>
 	<ul class="flex flex-1 gap-2">
-		{@render item('Doc', '/docs', '/docs')}
+		{@render item(m.h_doc(), '/docs', '/docs')}
+		{@render item(m.h_network(), '/flow', '/flow')}
 		{@render item('LM', '/lm/train', '/lm')}
-		{@render item('Build Network', '/flow', '/flow')}
 	</ul>
 	<I18nButton class="mr-4" />
 	<DarkModeButton />

darkit/core/web/src/lib/components/header.svelte

@@ -1,17 +1,24 @@
 <script>
-	import DocsNavbar from '$lib/components/docs-navbar.svelte';
 	import Navigation from './navigation.json';
+	import ZhNavigation from './navigation_zh.json';
+	import { languageTag } from '$lib/paraglide/runtime';
+	import DocsNavbar from '$lib/components/docs-navbar.svelte';
 
 	let { children } = $props();
 
-	const docsContents = Navigation.map((item) => {
-		return {
-			caption: item.title,
-			contents: item.children.map((child) => {
-				return [child.title, child.path];
-			})
-		};
-	});
+	const navigation = $derived(languageTag() === 'zh' ? ZhNavigation : Navigation);
+
+	const docsContents = $derived(
+		navigation.map((item) => {
+			return {
+				caption: item.title,
+				contents: item.children.map((child) => {
+					const title = child.metadata.title || child.title;
+					return [title, child.path];
+				})
+			};
+		})
+	);
 </script>
 
 <DocsNavbar contents={docsContents} />