|
35 | 35 | "- `leak_scaling_function`: The scaling function to use for leakage power. Use `None` if\n", |
36 | 36 | " no scaling should be done.\n", |
37 | 37 | "- `include_subcomponents`: Whether to also scale the subcomponents by the same factors.\n", |
38 | | - " Defaults to `True`; pass `False` to scale only this component.\n", |
| 38 | + " Defaults to `True`.\n", |
39 | 39 | "\n", |
40 | 40 | "Many different scaling functions are defined and available in `hwcomponents.scaling`.\n", |
41 | 41 | "\n", |
42 | | - "The `area_scale`, `energy_scale`, `latency_scale`, `throughput_scale`, and\n", |
43 | | - "`leak_power_scale` attributes are read-only properties that report a component's\n", |
44 | | - "accumulated scale factors. To change them outside of `self.scale`, call the matching\n", |
45 | | - "`scale_area`, `scale_energy`, `scale_latency`, `scale_throughput`, or `scale_leak_power`\n", |
46 | | - "method. Each takes a required `include_subcomponents` argument." |
| 42 | + "You may see what the result of scaling is by checking the `area_scale`, `energy_scale`,\n", |
| 43 | + "`latency_scale`, `throughput_scale`, and `leak_power_scale` attributes of a component.\n", |
| 44 | + "Note that these apply to the component directly, not subcomponents. You may also\n", |
| 45 | + "manually modify these with the `scale_area`, `scale_energy`, `scale_latency`,\n", |
| 46 | + "`scale_throughput`, or `scale_leak_power` methods." |
47 | 47 | ] |
48 | 48 | }, |
49 | 49 | { |
|
227 | 227 | "- An adder that adds the increment value to the current address\n", |
228 | 228 | "\n", |
229 | 229 | "One new functionality is used here. The `subcomponents` argument to the\n", |
230 | | - "`ComponentModel` constructor is used to register subcomponents.\n", |
231 | | - "\n", |
232 | | - "A component's area and leak power add up from its subcomponents, and subcomponent action\n", |
233 | | - "costs accumulate into the component's actions. To scale a compound model, the\n", |
234 | | - "`scale_area`, `scale_energy`, `scale_latency`, `scale_throughput`, and `scale_leak_power`\n", |
235 | | - "methods (and `self.scale`) take an `include_subcomponents` argument: pass `True` to scale\n", |
236 | | - "the component together with all of its subcomponents, or `False` to scale only this\n", |
237 | | - "component and leave the subcomponents untouched." |
| 230 | + "`ComponentModel` constructor is used to register subcomponents." |
238 | 231 | ] |
239 | 232 | }, |
240 | 233 | { |
|
0 commit comments