open-neuromorphic / open-neuromorphic.github.io

Public website, hosted through GitHub pages.
https://open-neuromorphic.org
MIT License
13 stars 16 forks source link

Review and improve info about Akida by Brainchip #143

Closed biphasic closed 5 months ago

biphasic commented 6 months ago

The website

The code for the live version of open-neuromorphic.org is hosted on the main branch at our GitHub repository. The site contains educational content on neuromorphic software libraries and hardware.

What to improve

The current entry for Akida is located here and would benefit from more detailed info.

Following info should be checked or added in the header:

Following info should be added in the text body.

Following things would be nice to have:

Feel free to add any relevant information you think would be beneficial. If you have questions or need clarification on any topic, please open a PR and ask. We encourage both seasoned contributors and newcomers to participate. Our team is ready to assist you in this process, both on Github or on Discord. Please keep the discussions public at all times.

Workflow

  1. Comment on this issue to express interest, so that our team can assign it to you. That'll let other people know that you're working on it.
  2. Fork this repository
  3. Make the changes in your fork and commit them on a new branch.
  4. Follow the instructions to build the website locally and check that the new page renders nicely.
  5. Create a pull request from the new branch in your fork into main in the original repository.

Writing style

Our aim is to create a central hub for educational content on neuromorphic computing. The content should be formally written, accessible to the public, and include references or images where appropriate. Feel free to include yourself in an authors statement at the bottom of the page. Please avoid overly general comments (as sometimes generated by ChatGPT).

DRosen766 commented 6 months ago

I can complete this

biphasic commented 6 months ago

@DRosen766 I have updated the issue description to clarify the workflow and added a few more points on info that should go into the article. Any questions let me know. I currently don't have a reference example page to link to, but will link one as soon as I have one

DRosen766 commented 6 months ago

@biphasic Sounds good, working on it now

DRosen766 commented 6 months ago

Still working on installing. For someone who installed/built properly, did you need the extended version of hugo?

Update: nevermind, I see where that's stated now

DRosen766 commented 6 months ago

I'm receiving this error when running the dev script: failed to process shortcode: "~\open-neuromorphic.github.io\themes\hugoplate\layouts\shortcodes\override-image.html:30:6": execute of template failed: template: shortcodes/override-image.html:30:6: executing "shortcodes/override-image.html" at <fileExists (addstatic/$imagePath)>: error calling fileExists: CreateFile ~\open-neuromorphic.github.io\static\https:\d3i71xaburhd42.cloudfront.net\df3434c56233f707da2383620667d57632eaff72\2-Figure1-1.png: The filename, directory name, or volume label syntax is incorrect.

It seems some of the shortcodes are not compatible with Windows machines because of the format of paths (direction of /). So things like fileExists are breaking. I'm happy to work on fixing, @biphasic want me to open a new issue? Also doesn't work on wsl

neural-loop commented 6 months ago

Hi @DRosen766, please do correct the shortcodes for Windows if you are able. Odd that it still errors on WSL. I don't immediately recognize the cloudfront path.

DRosen766 commented 6 months ago

@neural-loop The cloudfront path is the url of the image in index.md. Would it be possible to just add those images to the repo so they are stored locally and don't have to be downloading the image every time.

neural-loop commented 6 months ago

@DRosen766 I added the images in a new commit, does that prevent the error?

DRosen766 commented 6 months ago

@neural-loop Yeah, working now thanks

cantordust commented 6 months ago

@DRosen766 I'd be happy to contribute to this too, I recently had some close encounters with Akida.

DRosen766 commented 6 months ago

@cantordust sounds good, want access to my fork or are you making your own? I'm currently working on the header section info

biphasic commented 6 months ago

It's normally easiest if you add him as a collaborator in your fork (check settings in the fork repo)

wbenoot commented 6 months ago

The same goes for me, I can double check / review any of the more ambiguous parts If you guys like that. Recently had some very deep dives into the underlying implementation.

DRosen766 commented 6 months ago

@wbenoot I'll add you as well. I'm still very new to this stuff so that sounds great.

neural-loop commented 6 months ago

Just an idea, it might be easier to collaboratively write it up in a shared google doc and then move it over to markdown once everyone is happy with it.

wbenoot commented 6 months ago

I agree, especially if you still need to set up the website locally. We could also meet on Discord once to get cracking on all these checkboxes and the document.

DRosen766 commented 6 months ago

@wbenoot sounds good What time zone are you in?

wbenoot commented 6 months ago

I'm in CET, I'm free this weekend if you guys are up for it @DRosen766 @cantordust ?

biphasic commented 6 months ago

@wbenoot if you could take the lead on drafting a first version that would be fantastic. Then @DRosen766 and @cantordust can fill in info! Feel free to use Gdocs if you think it's easier. I'm happy to render it locally to test that everything looks good on the website if it helps. I'll be available on the weekend. Saturday early afternoon? Sunday evening?

DRosen766 commented 6 months ago

@biphasic Sounds good. Sunday works for me.

wbenoot commented 6 months ago

I can also join for a moment sunday evening

DRosen766 commented 6 months ago

I have all the first section except synapses

DRosen766 commented 6 months ago

pushed intro data to my repo

biphasic commented 6 months ago

great! Do you think you could open a pull request from your feature branch in your fork into the main branch of this repo? You can mark it as draft, but that would make it visible to everyone

cantordust commented 6 months ago

@DRosen766 Apologies, I had misconfigured my GitHub notifications🤦. If the offer is still on the table, I can work in your branch, otherwise I can make my own fork.

DRosen766 commented 6 months ago

@cantordust no problem. You should have an invite from my fork from a couple weeks ago. You're welcome to join that

cantordust commented 6 months ago

Ah shoot, it has expired :( Would you be able to send another one, please?🙏

DRosen766 commented 6 months ago

@cantordust for sure, just sent

cantordust commented 6 months ago

Thank you, accepted! 👍🏼

biphasic commented 5 months ago

Hey peeps, @cantordust @wbenoot could you please add some more info to @DRosen766 's branch? https://github.com/open-neuromorphic/open-neuromorphic.github.io/pull/173 Thanks a lot

cantordust commented 5 months ago

@biphasic I finally had some time to sit down and focus on this. I added information about the parts that I have had experience with, mainly training. Other parts can probably be extended further. Let me know if anything needs to be changed!

biphasic commented 5 months ago

Where can I see those changes? Because they're not in the open PR, that means you didn't push them on his branch

cantordust commented 5 months ago

@biphasic Pushed to the correct branch, sorry about that!

biphasic commented 5 months ago

closed in https://github.com/open-neuromorphic/open-neuromorphic.github.io/pull/173