Merge pull request #275 from Zerohertz/chore-v1.0.2

[v1.0.2] Docs Update
Zerohertz · Apr 3, 2024 · 2e52e80 · 2e52e80
2 parents e6e3b1e + ff08528
commit 2e52e80
Show file tree

Hide file tree

Showing 51 changed files with 63 additions and 14 deletions.
diff --git a/docs/_images/monitoring.storage.png b/docs/_images/monitoring.storage.png
diff --git a/docs/_images/plot.candle.png b/docs/_images/plot.candle.png
diff --git a/docs/_images/plot.hist.png b/docs/_images/plot.hist.png
diff --git a/docs/_images/plot.plot.1.png b/docs/_images/plot.plot.1.png
diff --git a/docs/_images/plot.plot.2.png b/docs/_images/plot.plot.2.png
diff --git a/docs/_images/plot.scatter.png b/docs/_images/plot.scatter.png
diff --git a/docs/_images/quant.bollinger_bands.png b/docs/_images/quant.bollinger_bands.png
diff --git a/docs/_images/quant.macd.png b/docs/_images/quant.macd.png
diff --git a/docs/_images/quant.momentum.png b/docs/_images/quant.momentum.png
diff --git a/docs/_images/quant.moving_average.png b/docs/_images/quant.moving_average.png
diff --git a/docs/_images/quant.rsi.png b/docs/_images/quant.rsi.png
diff --git a/docs/_images/vision.grid.png b/docs/_images/vision.grid.png
diff --git a/docs/_images/vision.mask.png b/docs/_images/vision.mask.png
diff --git a/docs/_images/vision.vert.png b/docs/_images/vision.vert.png
diff --git a/docs/_sources/release/v0.1.md.txt b/docs/_sources/release/v0.1.md.txt
@@ -99,7 +99,7 @@
 
 <h4>Docs</h4>
 
-+ 기타 sphinx 문서의 오타, 양식 수정
++ 기타 Sphinx 문서의 오타, 양식 수정
 
 ## v0.1.7
 

diff --git a/docs/_sources/release/v1.0.md.txt b/docs/_sources/release/v1.0.md.txt
@@ -2,6 +2,24 @@
 
 ## v1.0.2
 
+<h3>[v1.0.2] Docs Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/275>#275</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/04/03
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Docs</h4>
+
++ Sphinx 내 오타 수정
+
 <h3>[v1.0.2] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/273>#273</a>)</h3>
 
 ```{admonition} Release Date

diff --git a/docs/_static/examples/dynamic/monitoring.storage.png b/docs/_static/examples/dynamic/monitoring.storage.png
diff --git a/docs/_static/examples/dynamic/plot.candle.png b/docs/_static/examples/dynamic/plot.candle.png
diff --git a/docs/_static/examples/dynamic/plot.hist.png b/docs/_static/examples/dynamic/plot.hist.png
diff --git a/docs/_static/examples/dynamic/plot.plot.1.png b/docs/_static/examples/dynamic/plot.plot.1.png
diff --git a/docs/_static/examples/dynamic/plot.plot.2.png b/docs/_static/examples/dynamic/plot.plot.2.png
diff --git a/docs/_static/examples/dynamic/plot.scatter.png b/docs/_static/examples/dynamic/plot.scatter.png
diff --git a/docs/_static/examples/dynamic/quant.bollinger_bands.png b/docs/_static/examples/dynamic/quant.bollinger_bands.png
diff --git a/docs/_static/examples/dynamic/quant.macd.png b/docs/_static/examples/dynamic/quant.macd.png
diff --git a/docs/_static/examples/dynamic/quant.momentum.png b/docs/_static/examples/dynamic/quant.momentum.png
diff --git a/docs/_static/examples/dynamic/quant.moving_average.png b/docs/_static/examples/dynamic/quant.moving_average.png
diff --git a/docs/_static/examples/dynamic/quant.rsi.png b/docs/_static/examples/dynamic/quant.rsi.png
diff --git a/docs/_static/examples/dynamic/vision.grid.png b/docs/_static/examples/dynamic/vision.grid.png
diff --git a/docs/_static/examples/dynamic/vision.mask.png b/docs/_static/examples/dynamic/vision.mask.png
diff --git a/docs/_static/examples/dynamic/vision.vert.png b/docs/_static/examples/dynamic/vision.vert.png
diff --git a/docs/release/v0.1.html b/docs/release/v0.1.html
@@ -371,7 +371,7 @@ <h4>Features</h4>
 </ul>
 <h4>Docs</h4>
 <ul class="simple">
-<li><p>기타 sphinx 문서의 오타, 양식 수정</p></li>
+<li><p>기타 Sphinx 문서의 오타, 양식 수정</p></li>
 </ul>
 </section>
 <section id="v0-1-7">

diff --git a/docs/release/v1.0.html b/docs/release/v1.0.html
@@ -17,10 +17,10 @@
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://zerohertz.github.io/zerohertzLib/release/v1.0.html" />
 <meta property="og:site_name" content="Zerohertz's Library v1.0.2 Documents" />
-<meta property="og:description" content="v1.0.2: mlops- TritonClientURL& TritonClientK8s- tritonclient.grpc.InferenceServerClient 를 attribute로 가지는 것에서 상속 구조로 refactoring, Triton Inference Server의 현재 상태를 확인할 수 있는 status method 추가, Triton I..." />
+<meta property="og:description" content="v1.0.2: Sphinx 내 오타 수정. mlops- TritonClientURL& TritonClientK8s- tritonclient.grpc.InferenceServerClient 를 attribute로 가지는 것에서 상속 구조로 refactoring, Triton Inference Server의 현재 상태를 확인할 수 있는 status met..." />
 <meta property="og:image" content="https://zerohertz.github.io/zerohertzLib/_static/og.png" />
 <meta property="og:image:alt" content="Zerohertz's Library v1.0.2 Documents" />
-<meta name="description" content="v1.0.2: mlops- TritonClientURL& TritonClientK8s- tritonclient.grpc.InferenceServerClient 를 attribute로 가지는 것에서 상속 구조로 refactoring, Triton Inference Server의 현재 상태를 확인할 수 있는 status method 추가, Triton I..." />
+<meta name="description" content="v1.0.2: Sphinx 내 오타 수정. mlops- TritonClientURL& TritonClientK8s- tritonclient.grpc.InferenceServerClient 를 attribute로 가지는 것에서 상속 구조로 refactoring, Triton Inference Server의 현재 상태를 확인할 수 있는 status met..." />
     <link href="../_static/favicon.png" sizes="802x802" rel="icon" type="image/png">
     <link href="../_static/favicon-16x16.png" sizes="16x16" rel="icon" type="image/png">
     <link href="../_static/favicon-32x32.png" sizes="32x32" rel="icon" type="image/png">
@@ -265,6 +265,19 @@
 <h1>v1.0<a class="headerlink" href="#v1-0" title="Permalink to this heading">#</a></h1>
 <section id="v1-0-2">
 <h2>v1.0.2<a class="headerlink" href="#v1-0-2" title="Permalink to this heading">#</a></h2>
+<h3>[v1.0.2] Docs Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/275>#275</a>)</h3>
+<div class="tip admonition">
+<p class="admonition-title">Release Date</p>
+<p>2024/04/03</p>
+</div>
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+<h4>Docs</h4>
+<ul class="simple">
+<li><p>Sphinx 내 오타 수정</p></li>
+</ul>
 <h3>[v1.0.2] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/273>#273</a>)</h3>
 <div class="tip admonition">
 <p class="admonition-title">Release Date</p>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/zerohertzLib.mlops.html b/docs/zerohertzLib.mlops.html
@@ -397,7 +397,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>model</strong> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – 호출할 model의 이름</p></li>
+<li><p><strong>model</strong> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – 호출할 model의 이름 또는 ID</p></li>
 <li><p><strong>*args</strong> (<code class="docutils literal notranslate"><span class="pre">NDArray[DTypeLike]</span></code>) – Model 호출 시 사용될 입력</p></li>
 </ul>
 </dd>
@@ -450,7 +450,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>model</strong> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – 호출할 model의 이름</p></li>
+<li><p><strong>model</strong> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – 호출할 model의 이름 및 ID</p></li>
 <li><p><strong>*args</strong> (<code class="docutils literal notranslate"><span class="pre">NDArray[DTypeLike]</span></code>) – Model 호출 시 사용될 입력</p></li>
 </ul>
 </dd>
@@ -477,7 +477,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.load_model.params.model_name"></span><strong>model_name</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.load_model.params.model_name">¶</a> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – Unload할 model의 이름 및 ID</p></li>
+<li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.load_model.params.model_name"></span><strong>model_name</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.load_model.params.model_name">¶</a> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – Load할 model의 이름 또는 ID</p></li>
 <li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.load_model.params.headers"></span><strong>headers</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.load_model.params.headers">¶</a> (<code class="docutils literal notranslate"><span class="pre">Optional[Dict]</span></code>) – Request 전송 시 포함할 추가 HTTP header</p></li>
 <li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.load_model.params.config"></span><strong>config</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.load_model.params.config">¶</a> (<code class="docutils literal notranslate"><span class="pre">Optional[Dict]</span></code>) – Model load 시 사용될 config</p></li>
 <li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.load_model.params.config"></span><strong>config</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.load_model.params.config">¶</a> – Model load 시 override model directory에서 사용할 file</p></li>
@@ -518,7 +518,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.unload_model.params.model_name"></span><strong>model_name</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.unload_model.params.model_name">¶</a> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – Unload할 model의 이름 및 ID</p></li>
+<li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.unload_model.params.model_name"></span><strong>model_name</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.unload_model.params.model_name">¶</a> (<code class="docutils literal notranslate"><span class="pre">Union[int,</span> <span class="pre">str]</span></code>) – Unload할 model의 이름 또는 ID</p></li>
 <li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.unload_model.params.headers"></span><strong>headers</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.unload_model.params.headers">¶</a> (<code class="docutils literal notranslate"><span class="pre">Optional[Dict]</span></code>) – Request 전송 시 포함할 추가 HTTP header</p></li>
 <li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.unload_model.params.unload_dependents"></span><strong>unload_dependents</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.unload_model.params.unload_dependents">¶</a> (<code class="docutils literal notranslate"><span class="pre">Optional[bool]</span></code>) – Model unload 시 dependents의 unload 여부</p></li>
 <li><p><span class="target" id="zerohertzLib.mlops.TritonClientURL.unload_model.params.client_timeout"></span><strong>client_timeout</strong><a class="paramlink headerlink reference internal" href="#zerohertzLib.mlops.TritonClientURL.unload_model.params.client_timeout">¶</a> (<code class="docutils literal notranslate"><span class="pre">Optional[float]</span></code>) – 초 단위의 timeout</p></li>

diff --git a/sphinx/source/_static/examples/dynamic/monitoring.storage.png b/sphinx/source/_static/examples/dynamic/monitoring.storage.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.candle.png b/sphinx/source/_static/examples/dynamic/plot.candle.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.hist.png b/sphinx/source/_static/examples/dynamic/plot.hist.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.plot.1.png b/sphinx/source/_static/examples/dynamic/plot.plot.1.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.plot.2.png b/sphinx/source/_static/examples/dynamic/plot.plot.2.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.scatter.png b/sphinx/source/_static/examples/dynamic/plot.scatter.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.bollinger_bands.png b/sphinx/source/_static/examples/dynamic/quant.bollinger_bands.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.macd.png b/sphinx/source/_static/examples/dynamic/quant.macd.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.momentum.png b/sphinx/source/_static/examples/dynamic/quant.momentum.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.moving_average.png b/sphinx/source/_static/examples/dynamic/quant.moving_average.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.rsi.png b/sphinx/source/_static/examples/dynamic/quant.rsi.png
diff --git a/sphinx/source/_static/examples/dynamic/vision.grid.png b/sphinx/source/_static/examples/dynamic/vision.grid.png
diff --git a/sphinx/source/_static/examples/dynamic/vision.mask.png b/sphinx/source/_static/examples/dynamic/vision.mask.png
diff --git a/sphinx/source/_static/examples/dynamic/vision.vert.png b/sphinx/source/_static/examples/dynamic/vision.vert.png
diff --git a/sphinx/source/release/v0.1.md b/sphinx/source/release/v0.1.md
@@ -99,7 +99,7 @@
 
 <h4>Docs</h4>
 
-+ 기타 sphinx 문서의 오타, 양식 수정
++ 기타 Sphinx 문서의 오타, 양식 수정
 
 ## v0.1.7
 

diff --git a/sphinx/source/release/v1.0.md b/sphinx/source/release/v1.0.md
@@ -2,6 +2,24 @@
 
 ## v1.0.2
 
+<h3>[v1.0.2] Docs Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/275>#275</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/04/03
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Docs</h4>
+
++ Sphinx 내 오타 수정
+
 <h3>[v1.0.2] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/273>#273</a>)</h3>
 
 ```{admonition} Release Date

diff --git a/zerohertzLib/mlops/triton.py b/zerohertzLib/mlops/triton.py
@@ -53,7 +53,7 @@ class TritonClientURL(grpcclient.InferenceServerClient):
             Model 호출 수행
 
             Args:
-                model (``Union[int, str]``): 호출할 model의 이름
+                model (``Union[int, str]``): 호출할 model의 이름 및 ID
                 *args (``NDArray[DTypeLike]``): Model 호출 시 사용될 입력
 
             Returns:
@@ -194,7 +194,7 @@ def load_model(
         """Triton Inference Server 내 model을 load하는 함수
 
         Args:
-            model_name (``Union[int, str]``): Unload할 model의 이름 및 ID
+            model_name (``Union[int, str]``): Load할 model의 이름 또는 ID
             headers (``Optional[Dict]``): Request 전송 시 포함할 추가 HTTP header
             config (``Optional[str]``): Model load 시 사용될 config
             config (``Optional[Dict]``): Model load 시 override model directory에서 사용할 file
@@ -218,7 +218,7 @@ def unload_model(
         """Triton Inference Server 내 model을 unload하는 함수
 
         Args:
-            model_name (``Union[int, str]``): Unload할 model의 이름 및 ID
+            model_name (``Union[int, str]``): Unload할 model의 이름 또는 ID
             headers (``Optional[Dict]``): Request 전송 시 포함할 추가 HTTP header
             unload_dependents (``Optional[bool]``): Model unload 시 dependents의 unload 여부
             client_timeout (``Optional[float]``): 초 단위의 timeout
@@ -245,7 +245,7 @@ class TritonClientK8s(TritonClientURL):
             Model 호출 수행
 
             Args:
-                model (``Union[int, str]``): 호출할 model의 이름
+                model (``Union[int, str]``): 호출할 model의 이름 또는 ID
                 *args (``NDArray[DTypeLike]``): Model 호출 시 사용될 입력
 
             Returns: