No project description provided
Project description
DALM by Arcee
The Arcee client for executing domain-adpated language model routines
Installation
pip install arcee-py
Authenticating
Your Arcee API key is obtained at app.arcee.ai
In bash:
export ARCEE_API_KEY=********
In notebook:
import os
os.environ["ARCEE_API_KEY"] = "********"
Upload Context
Upload context for your domain adapted langauge model to draw from.
import arcee
arcee.upload_doc("pubmed", doc_name="doc1", doc_text="whoa")
# or
# arcee.upload_docs("pubmed", docs=[{"doc_name": "doc1", "doc_text": "foo"}, {"doc_name": "doc2", "doc_text": "bar"}]
Train DALM
Train a DALM with the context you have uploaded.
import arcee
dalm = arcee.train_dalm("medical_dalm", context="pubmed")
# Wait for training to complete
arcee.get_dalm_status("medical_dalm")
The DALM training procedure trains your model in context and stands up an index for your model to draw from.
DALM Generation
import arcee
med_dalm = arcee.get_dalm("medical_dalm")
med_dalm.generate("What are the components of Scoplamine?")
DALM Retrieval
Retrieve documents for a given query and to view them or plug into a different LLM.
import arcee
med_dalm = arcee.get_dalm("medical_dalm")
med_dalm.retrieve("my query")
Contributing
We use invoke
to manage this repo. You don't need to use it, but it simplifies the workflow.
Set up the repo
git clone https://github.com/arcee-ai/arcee-python && cd arcee-python
# optionally setup your virtual environment (recommended)
python -m venv .venv && source .venv/bin/activate
# install repo
pip install invoke
inv install
Format, lint, test
inv format # run black and ruff
inv lint # black check, ruff check, mypy
inv test # pytest
Publishing
We publish in this repo by creating a new release/tag in github. On release, a github action will
publish the __version__
of arcee-py that is in arcee/__init__.py
So you need to increase that version before releasing, otherwise it will fail
To create a new release
- Open a PR increasing the
__version__
of arcee-py. You can manually edit it or runinv uv
- Create a new release, with the name being the
__version__
of arcee-py
Manual release [not recommended]
We do not recommend this. If you need to, please make the version number an alpha or beta release.
If you need to create a manual release, you can run inv build && inv publish
Project details
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
Hashes for arcee_py-0.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12fed0abcc6a401acc76ad739197d4676dbf6fce702bc7a5b8e23d511cc0dd2d |
|
MD5 | 3f4bcfdf2c4acbf2b2702b79053619d3 |
|
BLAKE2b-256 | d66f2d3c14fe8ab7a45e302cdd3029cead7ef5a4edd71cd1714c630b78bbff52 |