Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
darshit-desai committed Oct 3, 2023
1 parent f9bd148 commit 602fb73
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Where is the report stored?
## Where is the report stored?

The report is stored in `docs/ starter.md.html`, additionally you can access the report online here https://darshit-desai.github.io/3dVision_Rendering_Basics_with_Pytorch3D/

# Code Running Instructions:
## Code Running Instructions:

The code needs to be run using bash scripts which are in the root folder. After extracting the code from the zip file, open the root folder in the terminal where the bash scripts are stored. Make sure your envrionment has pytorch3d and it's deps installed.

All the code is housed in the starter folder, for running the python scripts, I have made bash files and everything can be run by running the bash files.

## Problem 0.1 code running instructions:
### Problem 0.1 code running instructions:
Here's how to run the bash file for this python code:

./problem0_1.sh --image_size $image_size #image_size is a number like 256 or 512
Expand All @@ -19,7 +19,7 @@ The bash command for regenerating the output of my report:

Output is stored in `images/cow_render.jpg`

## Problem 1.1 code running instructions:
### Problem 1.1 code running instructions:
Here's how to run the bash file for this python code:

##image_size could be 256/512; num_frames could be between 10 to 36; output_file is usually default image/360render_cow.gif
Expand All @@ -31,7 +31,7 @@ The bash command for regenerating the output of my report:

The output is stored in `images\360render_cow.gif`.

## Problem 1.2 code running instructions:
### Problem 1.2 code running instructions:
Here's how to run the bash file for this python code:

#Duration set as 3 seconds can be changed, No. of frames can be changed, output file kept default as images/dolly.gif; image_size kept as 256
Expand All @@ -43,21 +43,21 @@ The bash command for regenerating the output of my report:

The output is stored in `images\dolly.gif`.

## Problem 2.1 and 2.2 code running instructions:
### Problem 2.1 and 2.2 code running instructions:
This bash script generates output for both the tasks of Tetrahedron ad cube 360 degree rendering.

./problem2.sh

The output is stored at path `images/360render_tetrahedron.gif` and `images/cube_360.gif` for tetrahedron and cube respectively

## Problem 3 code running instructions:
### Problem 3 code running instructions:
The bash script for regenerating the outputs of my report is given below:

./problem3.sh --num_frames 36 --image_size 512

The output is stored at path `images/retexture_360render.gif`

## Problem 4 code running instructions:
### Problem 4 code running instructions:
The bash script for getting all 4 views as generated and shown in the report is given below:

./problem4.sh
Expand All @@ -69,9 +69,9 @@ The output is stored at the following paths:
* images/transform_cow3.jpg
* images/transform_cow4.jpg

## Problem 5 code running instructions:
### Problem 5 code running instructions:

### Problem 5.1 code running instructions:
#### Problem 5.1 code running instructions:
The bash script for getting the generated outputs as shown in reports are as below:

./problem5_1.sh
Expand All @@ -82,14 +82,14 @@ The outputs of the 3 point cloud renders are stored at the following path:
* images/ PC2_360render.gif
* images/ PCUnion_360render.gif

### Problem 5.2 code running instructions:
#### Problem 5.2 code running instructions:
The bash script for getting the generated outputs as shown in the reports are as below:

./problem5_2.sh --num_samples 300 --render parametric

The output for the script is stored at the path `images/toroid_parametric_360render.gif`

### Problem 5.3 code running instructions:
#### Problem 5.3 code running instructions:
The bash script for getting the generated outputs as shown in the reports are as below:

./problem5_3.sh --render implicit
Expand Down

0 comments on commit 602fb73

Please sign in to comment.