mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-07-16 23:24:55 -05:00
cb0ae4082f
Run quartodoc build against the refactored package (engine/ extracted from core/, infra->infrastructure): regenerate the API reference so every stub points at the new paths. Adds engine.*/infrastructure.* stubs, removes the 41 stale core.solver.* / core.engine.* / core.scenarios.* / core.config.* / core.evaluation.* / infra*.qmd orphans, and refreshes the package pages (core now primitives-only) + index. Verified: all 47 documented symbols resolve in the new package; every index link resolves; zero stale mlsysim.core.<engine-mod> / mlsysim.infra references anywhere in docs/. (objects.json inventory is gitignored -- regenerated at build.)
34 lines
1.1 KiB
Plaintext
34 lines
1.1 KiB
Plaintext
# core.provenance.Sourced { #mlsysim.core.provenance.Sourced }
|
|
|
|
```python
|
|
core.provenance.Sourced()
|
|
```
|
|
|
|
Scalar with mandatory ``Provenance``. Subclasses ``float`` so appendix
|
|
LEGO cells can divide and format values without extra coercion.
|
|
|
|
## Attributes
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| [source](#mlsysim.core.provenance.Sourced.source) | Returns the reference string of the provenance source. |
|
|
| [url](#mlsysim.core.provenance.Sourced.url) | Returns the URL of the provenance source, if any. |
|
|
| [value](#mlsysim.core.provenance.Sourced.value) | Returns the underlying float value of the sourced scalar. |
|
|
|
|
## Methods
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| [render_markdown](#mlsysim.core.provenance.Sourced.render_markdown) | Renders a Markdown representation of the sourced scalar. |
|
|
|
|
### render_markdown { #mlsysim.core.provenance.Sourced.render_markdown }
|
|
|
|
```python
|
|
core.provenance.Sourced.render_markdown()
|
|
```
|
|
|
|
Renders a Markdown representation of the sourced scalar.
|
|
|
|
This includes the value, description, provenance kind, source reference,
|
|
and URL. It is used primarily by CLI commands to inspect values.
|