Skip to main content

RESTEP

Reason-based RAG for Early-Stage Developers for Community-based Prospecting (RE-STEP) is a GenAI prospecting tool to assess community-based factors in early-stage renewable-energy siting. It is targeted for early-stage developers in the renewable energy industry.

Requirements

Required packages

The following packages are required for restep:

  • torch (to learn how to install, please refer to pytorch.org)

  • transformers

  • accelerate

  • safetensors

  • sentencepiece

  • bitsandbytes

  • requests

  • PyPDF2

  • python-docx

  • langchain

  • tqdm

To install these packages, you can do the following:

pip install torch transformers accelerate safetensors sentencepiece bitsandbytes requests PyPDF2 python-docx langchain tqdm

GPU requirements

You require at least one GPU to use restep.

VRAM requirements depend on factors like the length of the document.

However, at least 16GB of VRAM is recommended

huggingface access token

You will need a huggingface access token. To obtain one:

  1. you'd first need to create a huggingface account if you do not have one.

  2. Create and store a new access token. To learn more, please refer to huggingface.co/docs/hub/en/security-tokens.

  3. Note: Some pre-trained large language models (LLMs) may require permissions. For more information, please refer to huggingface.co/docs/hub/en/models-gated.

  4. Request for permission for meta-llama/Llama-3.1-8B-Instruct at https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct.

Installation

To install in python, simply do the following:

pip install restep

Quick Start

Here we provide a quick example on how you can execute restep by providing a link to the local government document and your huggingface API key.

from restep import restep

api_key="<your huggingface API key>"

url_to_local_government_document"https://www.co.marshall.in.us/egov/documents/1739816106_82896.pdf"

print(restep(url_to_local_government_document,api_key))



# This will return: {"Sentiment": "NEGATIVE", "Summary": "Opposition from residents and board members, citing concerns over property values, wildlife, and agricultural land, with some board members questioning the project's compliance with the ordinance and requesting additional conditions."}

How does RE-STEP work?

Figure

Our paper is currently under review at ACM BuildSys '25. Stay-tuned for updates if you are curious for more details.

Metadata

Release files for restep 0.0.3

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

Source distribution (sdist)

Source distribution for restep 0.0.3
File Size Uploaded Provenance
restep-0.0.3.tar.gz 16.5 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 33.7 kB

Release files / restep-0.0.3.tar.gz

Download URL restep-0.0.3.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ac5bc5ee43ca5a5e09e1fa894124541496fd685acfb4ee02f18c3226f4ccd8bc
BLAKE2b-256 checksum
How to use checksums
30625491f1d78b674ff971e8488494dc01edcf950dfa427a31246c0235595415
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.5

Release files / restep-0.0.3-py3-none-any.whl

Download URL restep-0.0.3-py3-none-any.whl
Size 17.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b084981c72e96ae12d205f6412638c6316a4df110bb0b9adf68760fa41ff1b08
BLAKE2b-256 checksum
How to use checksums
e469318f1ec6dc0a075b32977ee82e80a9e4e7cb09bffa854998e122a949d190
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.5

Security for restep 0.0.3

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