fracapuano commited on
Commit
1b86ba8
1 Parent(s): 81a5d0a

fix: updated readme

Browse files
Files changed (1) hide show
  1. README.md +12 -73
README.md CHANGED
@@ -1,73 +1,12 @@
1
- <div align="center">
2
- <a href="https://ibb.co/gTkPrng">
3
- <img src="https://i.ibb.co/FXYXZfD/Nebul-OS-logo.png" alt="Nebul-OS-logo" border="0">
4
- </a>
5
- </div>
6
-
7
- # NebulOS: Fair, green AI. For Real 🌿
8
- Welcome to the GitHub repository of the 18th ASP cycle coolest project! 🚀
9
-
10
- With NebulOS, we push the boundaries AI adoption, focusing on how to design architectures tailored for the hardware on which they run.
11
- During this wonderful journey, we counted on the support of the amazing people at [Nebuly](https://www.nebuly.com/) (8.3k 🌟 on GitHub), as well the guidance and help by Prof. [Barbara Caputo](linkedin.com/in/barbara-caputo-a610201a7/?originalSubdomain=it) (Politecnico di Torino, Top50 Universities world-wide), and Prof. [Stefana Maja Broadbent](https://www.linkedin.com/in/stefanabroadbent/?originalSubdomain=uk) (Politecnico di Milano, Top20 Universities world-wide).
12
-
13
- Give us a star to show your support for the project ⭐
14
- You can find an extended abstract of this project [here](https://sites.google.com/view/nebulos)
15
-
16
- ## Foreword 📝
17
- ### Alta Scuola Politecnica (ASP)
18
- Alta Scuola Politecnica (more [here](https://www.asp-poli.it/)) is the **joint honors program** of Italy's best technical universities, Politecnico di Milano ([18th world-wide, QS Rankings](https://www.topuniversities.com/university-rankings/university-subject-rankings/2023/engineering-technology?&page=1)) and Politecnico di Torino ([45th world-wide, QS Rankings](https://www.topuniversities.com/university-rankings/university-subject-rankings/2023/engineering-technology?&page=1)).
19
- Each year, 90 students from Politecnico di Milano and 60 from Politecnico di Torino are selected from a highly competitive pool and those who succeed receive free tuition for their MSc in exchange for ~1.5 years working as **student consultants** with a partner company for an industrial project.
20
-
21
- The project we present has been carried out with the invaluable support of folks at [Nebuly](https://www.nebuly.com/), the company behind the very well-known [`nebullvm`](https://github.com/nebuly-ai/nebuly/tree/main/optimization/nebullvm) open-source AI-acceleration library 🚀
22
-
23
- Alongside them, we have developed a stable and reliable AI-acceleration tool that capable of designing just the right network for each specific target device.
24
- With this, we propose a new answer to an old Deep Learning question: how to bring large models to tiny devices. **Screw forcing a circle in a square-hole**: we feel like we are the trouble-makers here, *better to change the model from the ground up!*
25
-
26
- ## Contributions 🌟
27
- NebulOS takes a step further by adopting actual hardware-aware metrics (such as the architectures' energy consumption 🌿) to perform the automated design of Deep Neural Architectures.
28
-
29
- ## How to Reproduce the Results 💻
30
- 1. **Clone the Repository**: `git clone https://github.com/fracapuano/NebulOS.git`
31
- 2. **Install Dependencies**:
32
- After having made sure you have a working version of `conda` on your machine (you can double-check running the command `conda` in your terminal), go ahead:
33
- - Creating the environment (this code has been fully tested for Python 3.10)
34
- ```bash
35
- conda create -n nebulosenv python=3.10 -y
36
- ```
37
- - Activating the environment
38
- ```bash
39
- conda activate nebulosenv
40
- ```
41
- - Installing the (very minimal) necessary requirements
42
- ```bash
43
- pip install -r requirements.txt
44
- ```
45
- 3. **Run the Code**: Use the provided scripts and guidelines in the repository.
46
- To reproduce our results you can simply run the following command:
47
- ```bash
48
- python nas.py
49
- ```
50
-
51
- To specialize your search, you can select multiple arguments. You may select those of interest to you using Python args. To see all args available you run:
52
-
53
- ```bash
54
- python nas.py --help
55
- ```
56
-
57
- For instance, you can specify a search for an NVIDIA Jetson Nano device on ImageNet16-120 by running:
58
- ```bash
59
- python nas.py --device edgegpu --dataset ImageNet16-120
60
- ```
61
- ## Live-demo ⚡
62
- Our live demo is currently hosted as an Hugging Face space. You can find it at [spaces/fracapuano/NebulOS](https://huggingface.co/spaces/fracapuano/NebulOS)
63
-
64
- ## Next modules and roadmap
65
- We are actively working on obtaining the next results.
66
-
67
- - [ ] Extending this work to deal with Transformer networks in NLP.
68
- - [ ] Bring actual AI Optimization to LLMs.
69
-
70
- ## Conclusions 🌍
71
- We really hyped up about NebulOS because we feel it is way more than an extension; it's a revolution in the field of Green-AI. This project stays as a testament of our commitment toward truly sustainable AI, and by adopting actual hardware-aware metrics, we are making a tangible difference in the world of Deep Neural Architectures.
72
-
73
- Join us in this journey towards a greener future! Help us keep AI beneficial to all. This time, for real.
 
1
+ ---
2
+ title: {NebulOS}
3
+ emoji: {🌿}
4
+ colorFrom: {#FCEEB5}
5
+ colorTo: {#A7C7E7}
6
+ sdk: {streamlit}
7
+ sdk_version: {1.25.0}
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference