Skip to content

Commit da863a3

Browse files
Jammy2211Jammy2211claude
authored
docs: three-ways-to-learn guide + prune stale API-doc references (#593)
Phase C: add a 'Three Ways to Learn PyAutoLens' subsection (manual navigation / AI chat assistant / fully agentic AI) to the new-user guide and README; reframe autolens_assistant from experimental to a first-class option in README + docs/index. Phase A: prune docs/api/*.rst references to removed API — the OO plotting subsystem (MatPlot2D/Cmap/*Scatter, replaced by the functional plot API), PySwarms searches, PointDict, SetupAdapt->AdaptImages, OverSampling-> OverSampler, and dead linear Chameleon entries. Re-audit clean. Issue #592. Co-authored-by: Jammy2211 <JNightingale2211@gmail.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 42b0851 commit da863a3

8 files changed

Lines changed: 35 additions & 91 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
2323

2424
This is called strong gravitational lensing and **PyAutoLens** makes it **simple** to model strong gravitational lenses, using JAX to **accelerate lens modeling on GPUs**.
2525

26-
> 🤖 **Prototype:** [**autolens_assistant**](https://github.com/PyAutoLabs/autolens_assistant) is an early-stage AI assistant you talk to in natural language to do lens modeling end-to-end. It is experimental and **not the recommended starting point** — the readthedocs, autolens_workspace, and HowToLens below remain the canonical entry points. Try it if you'd like to drive PyAutoLens by conversation.
26+
> 🤖 **AI-assisted use:** you can also learn and drive **PyAutoLens** with AI — either a browser chat assistant (ChatGPT, Claude) pointed at [**autolens_assistant**](https://github.com/PyAutoLabs/autolens_assistant), or a fully agentic coding tool (Claude Code, Codex) that runs lens modeling end-to-end on your machine. See the **Three Ways to Learn PyAutoLens** section below.
2727
2828
## Getting Started
2929

@@ -34,6 +34,16 @@ The following links are useful for new starters:
3434
- [The autolens_workspace GitHub repository](https://github.com/PyAutoLabs/autolens_workspace): example scripts covering every **PyAutoLens** use case.
3535
- [The HowToLens GitHub repository](https://github.com/PyAutoLabs/HowToLens): a Jupyter notebook lecture series teaching strong lensing and lens modeling from the ground up.
3636

37+
## Three Ways to Learn PyAutoLens
38+
39+
There are three ways to learn how to use **PyAutoLens**, which you can freely mix and match:
40+
41+
1. **Manual navigation** — read the workspace guides yourself, starting from the [new user guide](https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) and the `start_here` notebooks, which are organised by lens scale and dataset type.
42+
2. **AI chat assistant** — ask questions to a conversational AI assistant such as ChatGPT or Claude in the browser. Point it at the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and ask a question like *"How do I model a galaxy-scale strong lens observed with Hubble imaging?"*.
43+
3. **Fully agentic AI** — drive **PyAutoLens** end-to-end with an agentic coding tool such as [Claude Code](https://claude.com/claude-code) or [Codex](https://developers.openai.com/codex) together with [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant). These can inspect your data, write and run scripts, and manage a lens-modeling project directly on your machine.
44+
45+
See [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) for more on the AI-assisted options (2 and 3).
46+
3747
## Community & Support
3848

3949
Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses

docs/api/data.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ For datasets taken with a CCD (or similar imaging device), including objects whi
3535
Imaging
3636
SimulatorImaging
3737
Convolver
38-
Convolver
3938

4039

4140
Interferometer
@@ -67,7 +66,7 @@ applied to datasets to apply over sampling to their fit.
6766
:template: custom-class-template.rst
6867
:recursive:
6968

70-
OverSampling
69+
OverSampler
7170

7271

7372
1D Data Structures

docs/api/mass.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,5 +187,3 @@ inversion during each likelihood evaluation rather than as a free non-linear par
187187
ExponentialGradientSph
188188
DevVaucouleurs
189189
DevVaucouleursSph
190-
Chameleon
191-
ChameleonSph

docs/api/modeling.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ Markov Chain Monte Carlo (MCMC) and Maximum Likelihood Estimaotrs (MLE).
3939
BFGS
4040
DynestyDynamic
4141
Emcee
42-
PySwarmsLocal
43-
PySwarmsGlobal
4442

4543
Priors
4644
------
@@ -65,4 +63,4 @@ Adapt
6563
.. autosummary::
6664
:toctree: generated/
6765

68-
SetupAdapt
66+
AdaptImages

docs/api/plot.rst

Lines changed: 0 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -97,83 +97,3 @@ Module-level functions for visualizing non-linear search results.
9797
corner_anesthetic
9898
subplot_parameters
9999
log_likelihood_vs_iteration
100-
101-
Plot Customization [aplt]
102-
-------------------------
103-
104-
Customize figures created via ``Plotter`` objects, including changing ``matplotlib`` settings and adding
105-
visuals to figures.
106-
107-
.. currentmodule:: autogalaxy.plot
108-
109-
.. autosummary::
110-
:toctree: _autosummary
111-
:template: custom-class-template.rst
112-
:recursive:
113-
114-
MatPlot1D
115-
MatPlot2D
116-
Visuals1D
117-
Visuals2D
118-
119-
Matplot Lib Wrappers [aplt]
120-
---------------------------
121-
122-
Wrappers for every ``matplotlib`` function used by a ``Plotter``, allowing for detailed customization of
123-
every figure and subplot.
124-
125-
.. currentmodule:: autogalaxy.plot
126-
127-
**Matplotlib Wrapper Base Objects:**
128-
129-
.. autosummary::
130-
:toctree: _autosummary
131-
:template: custom-class-template.rst
132-
:recursive:
133-
134-
Units
135-
Figure
136-
Axis
137-
Cmap
138-
Colorbar
139-
ColorbarTickParams
140-
TickParams
141-
YTicks
142-
XTicks
143-
Title
144-
YLabel
145-
XLabel
146-
Legend
147-
Output
148-
149-
**Matplotlib Wrapper 1D Objects:**
150-
151-
.. autosummary::
152-
:toctree: _autosummary
153-
:template: custom-class-template.rst
154-
:recursive:
155-
156-
YXPlot
157-
158-
**Matplotlib Wrapper 2D Objects:**
159-
160-
.. autosummary::
161-
:toctree: _autosummary
162-
:template: custom-class-template.rst
163-
:recursive:
164-
165-
ArrayOverlay
166-
GridScatter
167-
GridPlot
168-
VectorYXQuiver
169-
PatchOverlay
170-
VoronoiDrawer
171-
OriginScatter
172-
MaskScatter
173-
BorderScatter
174-
PositionsScatter
175-
IndexScatter
176-
MeshGridScatter
177-
ParallelOverscanPlot
178-
SerialPrescanPlot
179-
SerialOverscanPlot

docs/api/point.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ named point sources.
2020
:recursive:
2121

2222
PointDataset
23-
PointDict
2423

2524
Solver
2625
------

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
99
This is called strong gravitational lensing and **PyAutoLens** makes it simple to model strong gravitational lenses, using JAX to **accelerate lens modeling on GPUs**.
1010

1111
```{note}
12-
🤖 **Prototype:** [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) is an early-stage AI assistant you talk to in natural language to do lens modeling end-to-end. It is experimental and **not the recommended starting point** — the readthedocs, autolens_workspace, and HowToLens below remain the canonical entry points. Try it if you'd like to drive PyAutoLens by conversation.
12+
🤖 **AI-assisted use:** alongside reading the guides, you can learn and drive **PyAutoLens** with AI — either a browser chat assistant (ChatGPT, Claude) pointed at [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant), or a fully agentic coding tool (Claude Code, Codex) that runs lens modeling end-to-end on your machine. The [new user guide](https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) describes all three ways to learn.
1313
```
1414

1515
# Getting Started

docs/overview/overview_2_new_user_guide.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,27 @@
66
different types of data (e.g. imaging, interferometer, and point-source observations). Depending on the scientific questions you are interested in, the analysis you perform may differ significantly.
77

88
The autolens_workspace contains a suite of example Jupyter Notebooks, organised by lens scale and dataset type.
9-
To help you find the most appropriate starting point, we begin by answering two simple questions.
9+
10+
## Three Ways To Learn PyAutoLens
11+
12+
There are three ways to learn how to use **PyAutoLens**, which you are free to mix and match:
13+
14+
1. **Manual Navigation**: Read the workspace guides yourself. To find the example notebook best suited to your
15+
science case, work through the two questions below ("What Scale Lens?" and "What Dataset Type?"), which point you
16+
to the right starting point. This is the traditional route, and the rest of this guide supports it.
17+
18+
2. **AI Chat Assistant**: Ask questions to a conversational AI assistant such as ChatGPT or Claude in the browser.
19+
Point it at the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and ask questions
20+
like *"How do I model a galaxy-scale strong lens observed with Hubble imaging?"*. This is ideal for learning the API,
21+
working out how to perform a calculation, and interpreting or debugging errors.
22+
23+
3. **Fully Agentic AI**: Use an agentic coding tool such as [Claude Code](https://claude.com/claude-code) or
24+
[Codex](https://developers.openai.com/codex) together with [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant).
25+
These can inspect your data, write and run scripts, and manage an end-to-end lens modeling project directly on your
26+
machine. See the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository for more information.
27+
28+
The rest of this guide supports **manual navigation**: we begin by answering two simple questions to find your most
29+
appropriate starting point.
1030

1131
## What Scale Lens?
1232

0 commit comments

Comments
 (0)