Skip to main content

Syphus: Automatic Instruction-Response Generation Pipeline

Hits

Paper | Documents | PyPI | Source Code

Installation

pip install --upgrade syphus

CLI Usage

You can easily use the Syphus CLI for operations.

First, choose an empty folder for initialization:

syphus init <folder>

The structure of the folder will be:

<folder>/
    config/
        gpt_info.yaml
        prompt.yaml
    resources/
        media_infos.json

Configuration

You can edit gpt_info.yaml and prompt.yaml to customize the generation.

Edit Media Data

Then, change the resources/media_infos.json to include the media data you want to generate.

You can use two different styles of resources/media_infos.json:

{
    "id_1": {
        "data_1": "data_1_1",
        "data_2": {
            "data_2_1": "data_2_1_1",
            "data_2_2": "data_2_2_1",
        }
    },
    "id_2": [
        "data_2_1",
        "data_2_2",
    ],
    "id_3": "data_3",
    ...
}

or

[
    {
        "id": "id_1",
        "data_1": "data_1",
        "data_2": {
            "data_2_1": "data_2_1",
            "data_2_2": "data_2_2",
        }
    },
    {
        "id": "id_2",
        "data_1": "data_1",
        "data_2": "data_2",
    },
    ...
]

Optionally, you can change the resources/media_infos.json to resources/media_infos.jsonl, but the format should like the second one of resources/media_infos.json:

{"id": "id_1", "data_1": "data_1", "data_2": "data_2"}
{"id": "id_2", "data_1": "data_1", "data_2": "data_2"}

Generate

After editing the resources/media_infos.json, you can generate the instruction-response pairs:

syphus query <folder>

or

cd <folder>
syphus query

You can use syphus query --help to see more options.

Metadata

Release files for syphus 0.0.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for syphus 0.0.6.4
File Size Uploaded Provenance
syphus-0.0.6.4.tar.gz 26.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for syphus 0.0.6.4
File Interpreter ABI Platform
syphus-0.0.6.4-py3-none-any.whl Python 3 none any Details

Total release size: 59.9 kB

Release files / syphus-0.0.6.4.tar.gz

Download URL syphus-0.0.6.4.tar.gz
Size 26.3 kB
Tags Source
SHA-256 checksum
How to use checksums
9de6ed07cba03fea930ebc8ea243b0d9086625e380d1132500940f494dd0a131
BLAKE2b-256 checksum
How to use checksums
48a66f5fe38168855bc8e52b3d86c32dc72a69ccb773e01bc8fc6e0badb2915e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / syphus-0.0.6.4-py3-none-any.whl

Download URL syphus-0.0.6.4-py3-none-any.whl
Size 33.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3baba398b396e033e07cd8a94068edee38b596cb3898ffd5dfba84b329b7b9f3
BLAKE2b-256 checksum
How to use checksums
90a40f89eb596c02c57049c0136a91650f37be4597e05081dea3b690c8de9412
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Security for syphus 0.0.6.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page