Skip to content

Commit

Permalink
docs(tt_um_if/info.yaml): update documentation (#308)
Browse files Browse the repository at this point in the history
  • Loading branch information
mountains-high committed Nov 13, 2023
1 parent 32250f8 commit 2df885d
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions projects/tt_um_if/info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,24 @@ yaml_version: 4
# Here is a great example: https://github.com/davidsiaw/tt02-davidsiaw-stackcalc/blob/38c5647f83aad2aec675d566aa3d67b98f0aac81/info.yaml
documentation:
author: "Kembay Assel" # Your name
title: "Integrate-and-Fire Neuron. (Verilog Demo)" # Project title
language: "Verilog" # other examples include Verilog, Amaranth, VHDL, etc
description: "Implement a IF neuron in silicon." # Short description of what your project does
title: "Integrate-and-Fire Neuron." # Project title
language: "Verilog" # other examples include Verilog, Amaranth, VHDL, etc.
description: "Implement an IF neuron in silicon." # Short description of what your project does

# Longer description of how the project works. You can use standard markdown format.
# Longer description of how the project works. You can use the standard markdown format.
how_it_works: |
Apply an input current injection to the IF neuron using switches.
The IF neuron model fires a spike as soon as the input voltage crosses
the specified threshold without considering any leakage or time-dependent state.
#This gets added to a membrane potential
If the membrane potential exceeds the threshold then trigger a spike.
This gets added to a membrane potential.
If the membrane potential exceeds the threshold, then it triggers a spike.
# Instructions on how someone could test your project, include things like what buttons do what and how to set the clock if needed
how_to_test: |
After reset, the membrane potential set to 0.
Then change the inputs to change the current. A higher current should trigger a higher firing rate.
An 8-bit input current is applied to the IF neuron through the designated input (i.e., uio_in).
The membrane potential of the IF neuron will respond to the applied input current.
Larger currents will lead to a higher membrane potential.
The neuron is designed to generate a spike when the membrane potential exceeds a certain threshold.
# A description of what the inputs do (e.g. red button, SPI CLK, SPI MOSI, etc).
# A description of what the inputs do (e.g. red button, SPI CLK, SPI MOSI, etc.).
inputs:
- current bit 11
- current bit 12
Expand All @@ -54,7 +49,7 @@ documentation:
- current bit 16
- current bit 17
- current bit 18
# A description of what the outputs do (e.g. status LED, SPI MISO, etc)
# A description of what the outputs do (e.g. status LED, SPI MISO, etc.)
outputs:
- membrane potential bit a
- membrane potential bit b
Expand All @@ -81,4 +76,4 @@ documentation:
discord: "akembay" # Your discord handle, used for communication and automatically assigning tapeout role after a submission
doc_link: "" # URL to longer form documentation, eg the README.md in your repository
clock_hz: 10000000 # Clock frequency in Hz (if required)
picture: "" # relative path to a picture in your repository (must be 512kb or less)
picture: "figures/IF_design.png" # relative path to a picture in your repository (must be 512kb or less)

0 comments on commit 2df885d

Please sign in to comment.