A new project/tool called docmetrics.
Project description
DocMetrics
DocMetrics is a tool to analyze and measure the complexity and usefulness of documentation.
It does this using a set of multiple choice questions, that you wish your users to be able to answer after reading the documentation.
An LLM is then asked to answer these questions, with and without the documentation as part of its context. The difference in score is then used as a measure of the usefulness of the documentation.
The list of questions need to be provided to the tool by passing a --questions option pointing to a yaml file. See the sample_questions.yaml file for an example.
The choice of LLM can be configured, but defaults to Google's Gemini model. The set of tools available to the agent can also be configured.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file docmetrics-0.0.8.tar.gz.
File metadata
- Download URL: docmetrics-0.0.8.tar.gz
- Upload date:
- Size: 72.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0530015c25cbfb6d58196ef40fc829cfad5e93925eba4a3ad20cf0c2f2a98917
|
|
| MD5 |
f6e7d9356d262989a6afea440cb6016b
|
|
| BLAKE2b-256 |
737350f0bd9cb909adf4f2eeef46682ff122a3a60a77594631445988fa7f804c
|
Provenance
The following attestation bundles were made for docmetrics-0.0.8.tar.gz:
Publisher:
publish.yaml on mila-iqia/docmetrics
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
docmetrics-0.0.8.tar.gz -
Subject digest:
0530015c25cbfb6d58196ef40fc829cfad5e93925eba4a3ad20cf0c2f2a98917 - Sigstore transparency entry: 1358390105
- Sigstore integration time:
-
Permalink:
mila-iqia/docmetrics@dd349bc1b4ffdb0f1b654f8abe9e07d7f6e8057e -
Branch / Tag:
refs/tags/v0.0.8 - Owner: https://github.com/mila-iqia
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@dd349bc1b4ffdb0f1b654f8abe9e07d7f6e8057e -
Trigger Event:
release
-
Statement type:
File details
Details for the file docmetrics-0.0.8-py3-none-any.whl.
File metadata
- Download URL: docmetrics-0.0.8-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
43d22781b18624f6fa481e2be3745e16cd09d6537dd274ce0922440b682a8dff
|
|
| MD5 |
aad13e3ca29e7872afcd16d021ea1ea2
|
|
| BLAKE2b-256 |
e1fc0df30b771efa4ba799e5f62b9f04b84ab1021a51a93a8c55eba9964544c0
|
Provenance
The following attestation bundles were made for docmetrics-0.0.8-py3-none-any.whl:
Publisher:
publish.yaml on mila-iqia/docmetrics
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
docmetrics-0.0.8-py3-none-any.whl -
Subject digest:
43d22781b18624f6fa481e2be3745e16cd09d6537dd274ce0922440b682a8dff - Sigstore transparency entry: 1358390158
- Sigstore integration time:
-
Permalink:
mila-iqia/docmetrics@dd349bc1b4ffdb0f1b654f8abe9e07d7f6e8057e -
Branch / Tag:
refs/tags/v0.0.8 - Owner: https://github.com/mila-iqia
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@dd349bc1b4ffdb0f1b654f8abe9e07d7f6e8057e -
Trigger Event:
release
-
Statement type:
