Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bab2min committed Apr 26, 2021
1 parent ff09183 commit 4836a58
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 17 deletions.
16 changes: 12 additions & 4 deletions README.kr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ tomotopy 란?

지원하는 운영체제 및 Python 버전은 다음과 같습니다:

* Python 3.5 이상이 설치된 Linux (x86-64)
* Python 3.5 이상이 설치된 macOS 10.13나 그 이후 버전
* Python 3.5 이상이 설치된 Windows 7이나 그 이후 버전 (x86, x86-64)
* Python 3.5 이상이 설치된 다른 운영체제: 이 경우는 c++11 호환 컴파일러를 통한 소스코드 컴파일이 필요합니다.
* Python 3.6 이상이 설치된 Linux (x86-64)
* Python 3.6 이상이 설치된 macOS 10.13나 그 이후 버전
* Python 3.6 이상이 설치된 Windows 7이나 그 이후 버전 (x86, x86-64)
* Python 3.6 이상이 설치된 다른 운영체제: 이 경우는 c++14 호환 컴파일러를 통한 소스코드 컴파일이 필요합니다.

설치가 끝난 뒤에는 다음과 같이 Python3에서 바로 import하여 tomotopy를 사용할 수 있습니다.
::
Expand Down Expand Up @@ -254,6 +254,14 @@ tomotopy의 Python3 예제 코드는 https://github.com/bab2min/tomotopy/blob/ma

역사
-------
* 0.12.0 (2021-04-26)
* 이제 `tomotopy.DMRModel`와 `tomotopy.GDMRModel`가 다중 메타데이터를 지원합니다. (https://github.com/bab2min/tomotopy/blob/main/examples/dmr_multi_label.py 참조)
* `tomotopy.GDMRModel`의 성능이 개선되었습니다.
* 깊은 복사를 수행하는 `copy()` 메소드가 모든 토픽 모델 클래스에 추가되었습니다.
* `min_cf`, `min_df` 등에 의해 학습에서 제외된 단어가 잘못된 토픽id값을 가지는 문제가 해결되었습니다. 이제 제외단 단어들은 토픽id로 모두 `-1` 값을 가집니다.
* 이제 `tomotopy`에 의해 생성되는 예외 및 경고가 모두 Python 표준 타입을 따릅니다.
* 컴파일러 요구사항이 C++14로 상향되었습니다.

* 0.11.1 (2021-03-28)
* 비대칭 alpha와 관련된 치명적인 버그가 수정되었습니다. 이 버그로 인해 0.11.0 버전은 릴리즈에서 삭제되었습니다.

Expand Down
16 changes: 12 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ You can install tomotopy easily using pip. (https://pypi.org/project/tomotopy/)

The supported OS and Python versions are:

* Linux (x86-64) with Python >= 3.5
* macOS >= 10.13 with Python >= 3.5
* Windows 7 or later (x86, x86-64) with Python >= 3.5
* Other OS with Python >= 3.5: Compilation from source code required (with c++11 compatible compiler)
* Linux (x86-64) with Python >= 3.6
* macOS >= 10.13 with Python >= 3.6
* Windows 7 or later (x86, x86-64) with Python >= 3.6
* Other OS with Python >= 3.6: Compilation from source code required (with c++14 compatible compiler)

After installing, you can start tomotopy by just importing.
::
Expand Down Expand Up @@ -260,6 +260,14 @@ meaning you can use it for any reasonable purpose and remain in complete ownersh

History
-------
* 0.12.0 (2021-04-26)
* Now `tomotopy.DMRModel` and `tomotopy.GDMRModel` support multiple values of metadata (see https://github.com/bab2min/tomotopy/blob/main/examples/dmr_multi_label.py )
* The performance of `tomotopy.GDMRModel` was improved.
* A `copy()` method has been added for all topic models to do a deep copy.
* An issue was fixed where words that are excluded from training (by `min_cf`, `min_df`) have incorrect topic id. Now all excluded words have `-1` as topic id.
* Now all exceptions and warnings that generated by `tomotopy` follow standard Python types.
* Compiler requirements have been raised to C++14.

* 0.11.1 (2021-03-28)
* A critical bug of asymmetric alphas was fixed. Due to this bug, version 0.11.0 has been removed from releases.

Expand Down
3 changes: 2 additions & 1 deletion document/document_header.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
<a class="homelink" rel="home" title="tomotopy Home" href="/tomotopy" style="display:block; font-size:2em; font-weight:bold; color:#555; padding-bottom:.5em; border-bottom:1px solid silver;"> <img src="/tomotopy/tomoto.png" alt="" style="height:1.5em;"> tomotopy </a>
<a id='lang-en' href="../en/index.html">English</a> <a id='lang-kr' href="../kr/index.html">한국어</a>
<div id="version-link">
<span>v0.11.1</span>
<span>v0.12.0</span>
<ul>
<li><a href='/tomotopy/v0.12.0/en'>v0.12.0</a></li>
<li><a href='/tomotopy/v0.11.1/en'>v0.11.1</a></li>
<li><a href='/tomotopy/v0.10.2/en'>v0.10.2</a></li>
<li><a href='/tomotopy/v0.10.1/en'>v0.10.1</a></li>
Expand Down
16 changes: 12 additions & 4 deletions tomotopy/documentation.kr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ tomotopy 란?

지원하는 운영체제 및 Python 버전은 다음과 같습니다:

* Python 3.5 이상이 설치된 Linux (x86-64)
* Python 3.5 이상이 설치된 macOS 10.13나 그 이후 버전
* Python 3.5 이상이 설치된 Windows 7이나 그 이후 버전 (x86, x86-64)
* Python 3.5 이상이 설치된 다른 운영체제: 이 경우는 c++11 호환 컴파일러를 통한 소스코드 컴파일이 필요합니다.
* Python 3.6 이상이 설치된 Linux (x86-64)
* Python 3.6 이상이 설치된 macOS 10.13나 그 이후 버전
* Python 3.6 이상이 설치된 Windows 7이나 그 이후 버전 (x86, x86-64)
* Python 3.6 이상이 설치된 다른 운영체제: 이 경우는 c++14 호환 컴파일러를 통한 소스코드 컴파일이 필요합니다.

설치가 끝난 뒤에는 다음과 같이 Python3에서 바로 import하여 tomotopy를 사용할 수 있습니다.
::
Expand Down Expand Up @@ -335,6 +335,14 @@ tomotopy의 Python3 예제 코드는 https://github.com/bab2min/tomotopy/blob/ma

역사
-------
* 0.12.0 (2021-04-26)
* 이제 `tomotopy.DMRModel`와 `tomotopy.GDMRModel`가 다중 메타데이터를 지원합니다. (https://github.com/bab2min/tomotopy/blob/main/examples/dmr_multi_label.py 참조)
* `tomotopy.GDMRModel`의 성능이 개선되었습니다.
* 깊은 복사를 수행하는 `copy()` 메소드가 모든 토픽 모델 클래스에 추가되었습니다.
* `min_cf`, `min_df` 등에 의해 학습에서 제외된 단어가 잘못된 토픽id값을 가지는 문제가 해결되었습니다. 이제 제외단 단어들은 토픽id로 모두 `-1` 값을 가집니다.
* 이제 `tomotopy`에 의해 생성되는 예외 및 경고가 모두 Python 표준 타입을 따릅니다.
* 컴파일러 요구사항이 C++14로 상향되었습니다.

* 0.11.1 (2021-03-28)
* 비대칭 alpha와 관련된 치명적인 버그가 수정되었습니다. 이 버그로 인해 0.11.0 버전은 릴리즈에서 삭제되었습니다.

Expand Down
16 changes: 12 additions & 4 deletions tomotopy/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ You can install tomotopy easily using pip. (https://pypi.org/project/tomotopy/)

The supported OS and Python versions are:

* Linux (x86-64) with Python >= 3.5
* macOS >= 10.13 with Python >= 3.5
* Windows 7 or later (x86, x86-64) with Python >= 3.5
* Other OS with Python >= 3.5: Compilation from source code required (with c++11 compatible compiler)
* Linux (x86-64) with Python >= 3.6
* macOS >= 10.13 with Python >= 3.6
* Windows 7 or later (x86, x86-64) with Python >= 3.6
* Other OS with Python >= 3.6: Compilation from source code required (with c++14 compatible compiler)

After installing, you can start tomotopy by just importing.
::
Expand Down Expand Up @@ -339,6 +339,14 @@ meaning you can use it for any reasonable purpose and remain in complete ownersh

History
-------
* 0.12.0 (2021-04-26)
* Now `tomotopy.DMRModel` and `tomotopy.GDMRModel` support multiple values of metadata (see https://github.com/bab2min/tomotopy/blob/main/examples/dmr_multi_label.py )
* The performance of `tomotopy.GDMRModel` was improved.
* A `copy()` method has been added for all topic models to do a deep copy.
* An issue was fixed where words that are excluded from training (by `min_cf`, `min_df`) have incorrect topic id. Now all excluded words have `-1` as topic id.
* Now all exceptions and warnings that generated by `tomotopy` follow standard Python types.
* Compiler requirements have been raised to C++14.

* 0.11.1 (2021-03-28)
* A critical bug of asymmetric alphas was fixed. Due to this bug, version 0.11.0 has been removed from releases.

Expand Down

0 comments on commit 4836a58

Please sign in to comment.