Skip to content

Commit 368bcf5

Browse files
committed
Be consistent with usage of astra-rl
1 parent e00df30 commit 368bcf5

File tree

12 files changed

+18
-15
lines changed

12 files changed

+18
-15
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121

2222
# ASTRA-RL Toolbox
2323

24-
ASTRA-RL ("ASTRAL") Python toolbox for training and evaluating language models and generative AI systems that
24+
ASTRA-RL is a python toolbox for training and evaluating language models and generative AI systems that
2525
use textual inputs. It provides a set of tools for training, evaluating, and analyzing
2626
language models, with a focus on applying reinforcement learning based refinement techniques
2727
to improve evaluator model performance.
2828

2929
## Installation
3030

31-
To install the ASTRA toolbox, you can use pip. The package is available on PyPI, so you can install it directly from there.
31+
To install the ASTRA-RL toolbox, you can use pip. The package is available on PyPI, so you can install it directly from there.
3232

3333
```bash
3434
pip install astra-rl
@@ -37,7 +37,10 @@ pip install astra-rl
3737
You can then import the library in your Python code:
3838

3939
```python
40-
import astral
40+
import astra_rl
41+
42+
# Or
43+
import astra_rl as astral
4144
```
4245

4346
## Development
@@ -52,7 +55,7 @@ To start, we _STRONGLY_ recommend using [uv](https://docs.astral.sh/uv/) to mana
5255

5356
```bash
5457
git clone git@github.com:sisl/astra-rl.git
55-
cd astra
58+
cd astra-rl
5659
```
5760

5861
1. Sync package dependencies:

docs/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Library API
22

3-
This section provides detailed information about all the classes, functions, and modules available in the ASTRAL toolbox. Each entry includes a description of its purpose, parameters, and usage examples.
3+
This section provides detailed information about all the classes, functions, and modules available in the ASTRA-RL toolbox. Each entry includes a description of its purpose, parameters, and usage examples.
44

55
This documentation is generated automatically from the codebase using docstrings and comments, ensuring that it stays up-to-date with the latest changes.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Adaptive Stress Testing for Robust AI & Reinforcement Learning (ASTRAL)
1+
# Adaptive Stress Testing for Robust AI & Reinforcement Learning (ASTRA-RL)
22

3-
Welcome to the ASTRAL toolbox documentation! This documentation provides an overview of the ASTRAL toolbox, its features, and how to use it effectively.
3+
Welcome to the ASTRA-RL toolbox documentation! This documentation provides an overview of the ASTRA-RL toolbox, its features, and how to use it effectively.
44

55
!!! warning
66

docs/tutorials/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Tutorials
22

3-
This section provides step-by-step guides and examples to help you get started with the ASTRAL toolbox. Each tutorial covers a specific aspect of the toolbox, from basic usage to advanced features.
3+
This section provides step-by-step guides and examples to help you get started with the ASTRA-RL toolbox. Each tutorial covers a specific aspect of the toolbox, from basic usage to advanced features.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Training an Evaluator
22

3-
This tutorial will guide you through the process of training a custom model evaluator using the ASTRAL toolbox. The evaluator is a model that can be used to assess the quality of other models' outputs.
3+
This tutorial will guide you through the process of training a custom model evaluator using the ASTRA-RL toolbox. The evaluator is a model that can be used to assess the quality of other models' outputs.

mkdocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: ASTRAL Toolbox Documentation
1+
site_name: ASTRA-RL Toolbox Documentation
22
site_author: Duncan Eddy
33
site_description: Adaptive Stress Testing for Robust AI & Reinforcement Learning — a toolbox for testing and improving the robustness of AI systems.
44
site_url: https://github.com/sisl/astra-rl

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ dependencies = [
1717
]
1818

1919
[project.scripts]
20-
astral = "astral.cli.main:main"
20+
astral = "astra_rl.cli.main:main"
2121

2222
[tool.setuptools]
23-
py-modules = ['astral']
23+
py-modules = ['astra_rl']
2424

2525
[tool.setuptools.packages.find]
2626
where = ["src"]
File renamed without changes.
File renamed without changes.

src/astral/cli/evaluate.py renamed to src/astra_rl/cli/evaluate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@app.command(help="Evaluate a model using an evaluator model.")
66
def evaluate():
77
"""
8-
Evaluate a model using the Astral toolbox.
8+
Evaluate a model using the ASTRA-RL toolbox.
99
"""
1010
typer.echo("Evaluating model...")

0 commit comments

Comments
 (0)