Skip to content

Commit 0406bfa

Browse files
author
Avik Pal
committed
Add citation information and bunb project version
1 parent 03398a3 commit 0406bfa

File tree

4 files changed

+44
-1
lines changed

4 files changed

+44
-1
lines changed

CITATION.bib

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@misc{Suthar2020,
2+
author = {Nirmal Suthar, Avik Pal, Dhairya Gandhi},
3+
title = {Flux3D: A Framework for 3D Deep Learning in Julia},
4+
year = {2020},
5+
publisher = {GitHub},
6+
journal = {GitHub repository},
7+
howpublished = {\url{https://github.com/FluxML/Flux3D.jl}},
8+
}

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "Flux3D"
22
uuid = "432009dd-59a1-4b72-8c93-6462ce9b220f"
33
authors = ["Nirmal P. Suthar <[email protected]>"]
4-
version = "0.1.1"
4+
version = "0.1.2"
55

66
[deps]
77
CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
<a href="https://codecov.io/gh/FluxML/Flux3D.jl" alt="Codecov">
2222
<img src="https://codecov.io/gh/FluxML/Flux3D.jl/branch/master/graph/badge.svg?token=8kpPqDfChf"/>
2323
</a>
24+
<a href="https://github.com/SciML/ColPrac" alt="ColPrac: Contributor's Guide on Collaborative Practices for Community Packages">
25+
<img src="https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviole"/>
26+
</a>
2427
</p>
2528
<br/>
2629

@@ -123,6 +126,21 @@ TriMesh{Float32, UInt32, CUDA.CuArray} Structure:
123126
julia> save_trimesh("normalized_teapot.obj", new_m)
124127
```
125128

129+
## Citation
130+
131+
If you use this software as a part of your research or teaching, please cite this github repository. For convenience, we have also provided the bibtex entry in the form of `CITATION.bib` file.
132+
133+
```
134+
@misc{Suthar2020,
135+
author = {Nirmal Suthar, Avik Pal, Dhairya Gandhi},
136+
title = {Flux3D: A Framework for 3D Deep Learning in Julia},
137+
year = {2020},
138+
publisher = {GitHub},
139+
journal = {GitHub repository},
140+
howpublished = {\url{https://github.com/FluxML/Flux3D.jl}},
141+
}
142+
```
143+
126144
## Benchmarks
127145

128146
### PointCloud Transforms (Flux3D.jl and Kaolin)

docs/src/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,23 @@ julia> ] add Flux3D#master
4242

4343
---
4444

45+
## Citation
46+
47+
If you use this software as a part of your research or teaching, please cite this github repository. For convenience, we have also provided the bibtex entry in the form of `CITATION.bib` file in our github repo.
48+
49+
```
50+
@misc{Suthar2020,
51+
author = {Nirmal Suthar, Avik Pal, Dhairya Gandhi},
52+
title = {Flux3D: A Framework for 3D Deep Learning in Julia},
53+
year = {2020},
54+
publisher = {GitHub},
55+
journal = {GitHub repository},
56+
howpublished = {\url{https://github.com/FluxML/Flux3D.jl}},
57+
}
58+
```
59+
60+
---
61+
4562
## Contents
4663

4764
```@contents

0 commit comments

Comments
 (0)