Skip to content

Commit 4bd3d3f

Browse files
authored
Update README.md
1 parent 8668d24 commit 4bd3d3f

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

WOC/README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Working on AI/ML involves working with a wide range of specialized tools—rangi
1717
3.3 [Python Implementation of Gradient Descent Algorithm for Solving PortPy Optimization Problems](#PyGrad)
1818
3.4 [Python Implementation of the ADMM Algorithm for PortPy Optimization Problems](#PyADMM)
1919

20-
### 4. CI/CD package dissemination (website documentation and unit testing) (2 projects)
21-
4.1 [Creating a Documentation Website with CI/CD Features for PortPy](#website)
22-
4.2 [Creating Unit Tests with CI/CD Features for PortPy](#unittest)
20+
### 4. Creating a Documentation Website and Automated Unit Testing using GitOps CI/CD Features (2 projects)
21+
4.1 [Creating a Documentation Website with GitOps CI/CD Features for PortPy](#website)
22+
4.2 [Creating Unit Tests with GitOps CI/CD Features for PortPy](#unittest)
2323

2424
<br/>
2525

@@ -77,6 +77,7 @@ Current State: MLC movements are currently displayed as a series of static Matpl
7777
<h3 id="dose"> 1.3 Interactive Image Slice Navigation of CT Scan and Radiation Dose Map </h3>
7878

7979
**Requirements:** Matplotlib, Plotly or PyVista
80+
8081
**Good to Know:** PyQt
8182

8283
**Short description:**
@@ -150,6 +151,7 @@ Current Status: The PortPy.AI module currently implements a dose prediction pipe
150151
<h3 id="JaxOpt"> 3.1 Using Google's Jax.Opt to Solve PortPy Optimization Problems </h3>
151152

152153
**Requirements:** Proficiency in Python/NumPy, familiarity with optimization algorithms
154+
153155
**Good to Know:** Jax.Opt, SciPy
154156

155157
**Short description:**
@@ -167,6 +169,7 @@ Current Status: PortPy currently uses the open-source library [CVXPy](https://ww
167169
<h3 id="SciPy"> 3.2 Using SciPy.Optimize to Solve PortPy Optimization Problems </h3>
168170

169171
**Requirements:** Proficiency in Python, NumPy, SciPy
172+
170173
**Good to Know:** optimization algorithms
171174

172175
**Short description:**
@@ -180,6 +183,7 @@ This project is similar to the previous one, however, instead of Jax.Opt, we wou
180183
<h3 id="PyGrad"> 3.3 Python Implementation of Gradient Descent Algorithm for Solving PortPy Optimization Problems </h3>
181184

182185
**Requirements:** Proficiency in Python, Gradient Descent Algorithm, NumPy
186+
183187
**Good to Know:** JAX
184188

185189
**Short description:**
@@ -194,6 +198,7 @@ This project is similar to the previous ones; however, instead of relying on exi
194198
<h3 id="PyADMM"> 3.4 Python Implementation of the ADMM Algorithm for PortPy Optimization Problems </h3>
195199

196200
**Requirements:** Proficiency in Python, ADMM
201+
197202
**Good to Know:** JAX, CUDA, PyTorch, optimization techniques
198203

199204
**Short description:**
@@ -206,14 +211,15 @@ This project is similar to the previous one; however, instead of using gradient
206211
<br/>
207212

208213

209-
## 4. CI/CD package dissemination (website documentation and unit testing)
214+
## 4. Creating documentation website and unit testing using GitOps CI/CD featurs
210215
<h3 id="website"> 4.1 Creating a Documentation Website with CI/CD Features for PortPy </h3>
211216

212217
**Requirements:** Markdown
218+
213219
**Good to Know:** reStructuredText, Sphinx, CI/CD
214220

215221
**Short description:**
216-
Design and build a documentation website for PortPy using the Sphinx tool (see [YouTube-Sphinx-Crash-Course](https://www.youtube.com/watch?v=UourHBDZuR0) for a brief introduction). The website will resemble the [CVXPy-Website](https://www.cvxpy.org/) website but will feature different content (see the figures below for our initial website sketch). Ideally, we aim to incorporate modern CI/CD technology to enable easy and automated website updates in the future.
222+
Design and build a documentation website for PortPy using the Sphinx tool (see [YouTube-Sphinx-Crash-Course](https://www.youtube.com/watch?v=UourHBDZuR0) for a brief introduction). The website will resemble the [CVXPy-Website](https://www.cvxpy.org/) website but will feature different content (see the figures below for our initial website sketch). Ideally, we aim to incorporate modern GitOps CI/CD technology to enable easy and automated website updates in the future.
217223

218224
![Website Example](../images/web_1.png)
219225
![Website Example](../images/web_2.png)
@@ -228,16 +234,17 @@ Design and build a documentation website for PortPy using the Sphinx tool (see [
228234
<br/>
229235

230236

231-
<h3 id="unittest"> 4.2 Creating Unit Tests with CI/CD Features for PortPy </h3>
237+
<h3 id="unittest"> 4.2 Creating Unit Tests with GitOps CI/CD Features for PortPy </h3>
232238

233239
**Requirements:** Python
240+
234241
**Good to Know:** PyTest, CI/CD
235242

236243
**Short description:**
237-
Develop automated unit tests using the PyTest framework and few patients from the PortPy dataset. Additionally, integrate CI/CD technology to enable automatic testing for new releases, ensuring continuous quality and reliability of the PortPy project.
244+
Develop automated unit tests using the PyTest framework and few patients from the PortPy dataset. Additionally, integrate GitOps CI/CD technology to enable automatic testing for new releases, ensuring continuous quality and reliability of the PortPy project.
238245

239246
**Project Outcome:**
240-
- Implementation of unit tests integrated with CI/CD technology to ensure continuous quality checks for new releases.
247+
- Implementation of unit tests integrated with GitOps CI/CD technology to ensure continuous quality checks for new releases.
241248

242249
<br/>
243250

0 commit comments

Comments
 (0)