Skip to content

Commit

Permalink
feat: fixed some minor typos (#1319)
Browse files Browse the repository at this point in the history
  • Loading branch information
@proxima424
proxima424 committed Jul 10, 2023
1 parent 44dae41 commit 1b860b7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/python_vm/README.md
View file
Expand Up @@ -20,7 +20,7 @@ The memory itself is a list of continuous segments, the size of each segment may

The different segments:
* Program Segment: Contains cairo bytecode. pc starts at the beginning of this segment
* Execution Segment: Where data is generated during the run of a Cairo program. Lenght is variable(depends on program input). Allocation Pointer (ap) and Frame Pointer (fp) start here.
* Execution Segment: Where data is generated during the run of a Cairo program. Length is variable(depends on program input). Allocation Pointer (ap) and Frame Pointer (fp) start here.
* Builtin Segment: Each builtin has its own continuous area in memory. Length is variable

## Registers
Expand Down Expand Up @@ -53,14 +53,14 @@ The [VirtualMachine](https://github.com/starkware-libs/cairo-lang/blob/b614d1867
* [`run_context`](#context)
* `program` : [ProgramBase](#progbase)
* `program_base` : Optional(MaybeRelocatable)(if none, it is set to run_context.pc)
* `builtin_runners` (Optional Dict or set to {})
* `hint_locals` (Dict)
* `static_locals`(Optional Dict)
* `builtin_runners` : (Optional Dict or set to {})
* `hint_locals` : (Dict)
* `static_locals` : (Optional Dict)
VirtualMachineBase's init is used to set these values (plus other ones), the next ones are exclusive to the VirtualMachine:
* `accessed_addresses` (Set that keeps track of memory adresses accessed by cairo instructions)
* `trace` (List of TraceEntry, that each contain the run_context's pc, ap and fp at that moment. A TraceEntry is added after every instruction (Before update_registers is called))
* `current_step` (initialized with 0)
* `skip_instruction_execution` (= False), used by hints to skip execution of current step
* `accessed_addresses` : (Set that keeps track of memory adresses accessed by cairo instructions)
* `trace` : (List of TraceEntry, that each contain the run_context's pc, ap and fp at that moment. A TraceEntry is added after every instruction (Before update_registers is called))
* `current_step` : (initialized with 0)
* `skip_instruction_execution` : (= False), used by hints to skip execution of current step

Functions:
* `[update_registers(instruction, operands)]`(https://github.com/starkware-libs/cairo-lang/blob/b614d1867c64f3fb2cf4a4879348cfcf87c3a5a7/src/starkware/cairo/lang/vm/vm_core.py#L143): Updates fp, ap, and pc, based on the instruction's [FpUpdate, ApUpdate and PcUpdate](#updatereg)
Expand Down

1 comment on commit 1b860b7

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.30.

Benchmark suite Current: 1b860b7 Previous: 44dae41 Ratio
add_u64_with_felt/1 3 ns/iter (± 0) 2 ns/iter (± 0) 1.50
add_u64_with_felt/2 3 ns/iter (± 0) 2 ns/iter (± 0) 1.50
add_u64_with_felt/6 3 ns/iter (± 0) 2 ns/iter (± 0) 1.50
add_u64_with_felt/7 3 ns/iter (± 0) 2 ns/iter (± 0) 1.50
build runner 1756 ns/iter (± 71) 1304 ns/iter (± 1) 1.35
initialize 67251 ns/iter (± 1717) 51370 ns/iter (± 239) 1.31
parse program 26092640 ns/iter (± 354609) 18416601 ns/iter (± 236918) 1.42

This comment was automatically generated by workflow using github-action-benchmark.

CC: @unbalancedparentheses

Please sign in to comment.