A user toolkit for analyzing and interfacing with Large Language Models (LLMs)
Project description
Lingua-SDK
A user toolkit for analyzing and interfacing with Large Language Models (LLMs)
Overview
lingua-sdk
is a Python module used to interact with large language models
hosted via the Lingua service (available at https://github.com/VectorInstitute/lingua).
It provides a simple interface launch LLMs on an HPC cluster, ask them to
perform basic features like text generation, but also retrieve intermediate
information from inside the model such as log probabilities and activations.
These features are exposed via a few high-level APIs, namely:
generate_text
- Returns an LLM text generation based on prompt inputmodule_names
- Returns all modules in the LLM neural networkinstances
- Returns all active LLMs instantiated by the model service
Full documentation and API reference are available at http://lingua-sdk.readthedocs.io.
Getting Started
Install
python3 -m pip install pylingua
or install from source:
pip install git+https://github.com/VectorInstitute/lingua-sdk.git
Authentication
In order to submit text generation jobs, a designated Vector Institute cluster account is required. Please contact the AI Engineering Team in charge of Lingua for more information.
Sample Workflow
The following workflow shows how to load and interact with an OPT-175B model on the Vector Institute Vaughan cluster.
# Establish a client connection to the Lingua service
# If you have not previously authenticated with the service, you will be prompted to now
client = lingua.Client(gateway_host="llm.cluster.local", gateway_port=3001)
# Get a handle to a model. If this model is not actively running, it will get launched in the background.
# In this example we want to use the OPT model
opt_model = client.load_model("OPT")
# Show a list of modules in the neural network
print(opt_model.module_names)
# Sample text generation w/ input parameters
text_gen = opt_model.generate_text("What is the answer to life, the universe, and everything?", max_tokens=5, top_k=4, top_p=3, rep_penalty=1, temperature=0.5)
dir(text_gen) # display methods associated with generated text object
text_gen.text # display only text
text_gen.logprobs # display logprobs
text_gen.tokens # display tokens
Documentation
More information can be found on the Lingua documentation site.
Contributing
Contributing to lingua is welcomed. See Contributing for guidelines.
License
Citation
Reference to cite when you use Lingua in a project or a research paper:
Sivaloganathan, J., Coatsworth, M., Willes, J., Choi, M., & Shen, G. (2022). Lingua. http://VectorInstitute.github.io/lingua. computer software, Vector Institute for Artificial Intelligence. Retrieved from https://github.com/VectorInstitute/lingua-sdk.git.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.