Skip to content

Commit

Permalink
Fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ulises-jeremias committed May 27, 2023
1 parent 43d6f29 commit 8fbe201
Show file tree
Hide file tree
Showing 16 changed files with 80 additions and 75 deletions.
57 changes: 27 additions & 30 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,41 +1,38 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.140.1/containers/docker-existing-dockerfile
{
"name": "Existing Dockerfile",
"name": "Existing Dockerfile",

// Update the 'dockerfile' property if you aren't using the standard 'Dockerfile' filename.
"build": {
// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",
"dockerfile": "./Dockerfile",
"target": "vsl-dev",
"args": {
"DEV_IMG": "true"
}
},
// Update the 'dockerfile' property if you aren't using the standard 'Dockerfile' filename.
"build": {
// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",
"dockerfile": "./Dockerfile",
"target": "vsl-dev",
"args": {
"DEV_IMG": "true"
}
},

// Add the IDs of extensions you want installed when the container is created.
"customizations": {
"vscode": {
"extensions": [
"vlanguage.vscode-vlang",
"ms-vscode.cpptools"
]
}
},
// Add the IDs of extensions you want installed when the container is created.
"customizations": {
"vscode": {
"extensions": ["vlanguage.vscode-vlang", "ms-vscode.cpptools"]
}
},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Uncomment the next line to run commands after the container is created - for example installing curl.
// "postCreateCommand": "apt-get update && apt-get install -y curl",
// Uncomment the next line to run commands after the container is created - for example installing curl.
// "postCreateCommand": "apt-get update && apt-get install -y curl",

// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],

// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],

// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode"
// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode"
}
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ title: "(short issue description)"
labels: [bug]
assignees: []
body:

- type: textarea
id: description
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "(short issue description)"
labels: [documentation]
assignees: []
body:
- type: textarea
- type: textarea
id: description
attributes:
label: Describe the issue
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ body:
description: |
Why do you need this feature? For example: "I'm always frustrated when..."
validations:
required: true
required: true
- type: textarea
id: solution
attributes:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: VSL Continuous Integration

concurrency:
group: ci-${{ github.event.number }}
cancel-in-progress: true
group: ci-${{ github.event.number }}
cancel-in-progress: true

on:
# Allows you to run this workflow manually from the Actions tab
Expand Down Expand Up @@ -126,7 +126,7 @@ jobs:
- ubuntu-22.04
- ubuntu-20.04
- ubuntu-18.04
flags:
flags:
- ""
- "--prod"

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
jobs:
deploy-docs:
concurrency: deployment

runs-on: ubuntu-latest

steps:
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/docker-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ jobs:
docker:
uses: ./.github/workflows/docker-publish.yml
with:
dockerfile: './.devcontainer/Dockerfile'
dockerfile: "./Dockerfile"
context: "."
target: vsl-dev
tags: ulisesjeremias/vsl:dev
build-args: |
DEV_IMG=true
Expand Down
27 changes: 17 additions & 10 deletions .github/workflows/docker-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,36 @@ on:
workflow_call:
inputs:
dockerfile:
description: 'The dockerfile to use'
description: "The dockerfile to use"
type: string
required: false
default: './Dockerfile'
default: "./Dockerfile"
context:
description: 'The context to use'
description: "The context to use"
type: string
required: false
default: '.'
default: "."
target:
description: "The target to use"
type: string
required: false
default: ""
build-args:
description: 'The build args to use'
description: "The build args to use"
type: string
required: false
default: ''
default: ""
tags:
description: 'The tags to use'
description: "The tags to use"
type: string
required: false
default: ''
default: ""
secrets:
DOCKERHUB_USERNAME:
description: 'The username to use for the image'
description: "The username to use for the image"
required: true
DOCKERHUB_TOKEN:
description: 'The password to use for the image'
description: "The password to use for the image"
required: true

jobs:
Expand All @@ -54,3 +59,5 @@ jobs:
file: ${{ inputs.dockerfile }}
tags: ${{ inputs.tags }}
build-args: ${{ inputs.build-args }}
context: ${{ inputs.context }}
target: ${{ inputs.target }}
8 changes: 6 additions & 2 deletions .github/workflows/docker-stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ jobs:
docker-latest:
uses: ./.github/workflows/docker-publish.yml
with:
dockerfile: './Dockerfile'
dockerfile: "./Dockerfile"
context: "."
target: "vsl"
tags: ulisesjeremias/vsl:latest
build-args: |
DEV_IMG=false
Expand All @@ -24,7 +26,9 @@ jobs:
docker-tag:
uses: ./.github/workflows/docker-publish.yml
with:
dockerfile: './Dockerfile'
dockerfile: "./Dockerfile"
context: "."
target: "vsl"
tags: ulisesjeremias/vsl:${{ github.ref_name }}
build-args: |
DEV_IMG=false
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@

VSL is a V library to develop Artificial Intelligence and High-Performance Scientific Computations.

| | | | |
| :-----------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-------------------------------------------------------------------: | :--------------------------------------------------------------------------: |
| ![sierpinski_triangle](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle.png) | ![mandelbrot_blue_red_black](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_blue_red_black.png) | ![julia](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia.png) | ![mandelbrot_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_basic.png) |
| ![mandelbrot_pseudo_random_colors](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_pseudo_random_colors.png) | ![sierpinski_triangle2](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle2.png) | ![julia_set](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_set.png) | ![julia_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_basic.png) |
| | | | |
| :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------: |
| ![sierpinski_triangle](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle.png) | ![mandelbrot_blue_red_black](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_blue_red_black.png) | ![julia](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia.png) | ![mandelbrot_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_basic.png) |
| ![mandelbrot_pseudo_random_colors](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_pseudo_random_colors.png) | ![sierpinski_triangle2](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle2.png) | ![julia_set](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_set.png) | ![julia_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_basic.png) |

## Docs

Expand Down Expand Up @@ -119,7 +119,6 @@ Made with [contributors-img](https://contrib.rocks).
[deploydocsbadge]: https://github.com/vlang/vsl/actions/workflows/deploy-docs.yml/badge.svg
[licensebadge]: https://img.shields.io/badge/License-MIT-blue.svg
[ModulesBadge]: https://img.shields.io/badge/modules-reference-027d9c?logo=v&logoColor=white&logoWidth=10

[awesomevurl]: https://github.com/vlang/awesome-v/blob/main/README.md#scientific-computing
[workflowurl]: https://github.com/vlang/vsl/actions/workflows/ci.yml
[deploydocsurl]: https://github.com/vlang/vsl/actions/workflows/deploy-docs.yml
Expand Down
6 changes: 3 additions & 3 deletions fft/pocket-fft/LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its contributors may
- Neither the name of the copyright holder nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.

Expand Down
11 changes: 4 additions & 7 deletions fft/pocket-fft/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
PocketFFT
---------
## PocketFFT

This is a heavily modified implementation of FFTPack [1,2], with the following
advantages:
Expand All @@ -10,13 +9,11 @@ advantages:
- worst case complexity for transform sizes with large prime factors is
`N*log(N)`, because Bluestein's algorithm [3] is used for these cases.

License
-------
## License

3-clause BSD (see LICENSE.md)

Some code details
-----------------
## Some code details

Twiddle factor computation:

Expand Down Expand Up @@ -46,7 +43,7 @@ instead of an FFT of length `n`, a convolution of length `n2 >= 2*n-1`
is performed, where `n2` is chosen to be highly composite.

[1] Swarztrauber, P. 1982, Vectorizing the Fast Fourier Transforms
(New York: Academic Press), 51
(New York: Academic Press), 51

[2] <https://www.netlib.org/fftpack/>

Expand Down
2 changes: 1 addition & 1 deletion io/h5/TODO.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# TODO

- [ ] Fix the memory consumption for writing 2-d or 3-d arrays: currently this uses
the flatten() function which requires a temporary copy of the data.
the flatten() function which requires a temporary copy of the data.
- [ ] Add more examples.
- [ ] Add more datatypes, especially images.
- [ ] Consider adding a file open-for-update function.
Expand Down
8 changes: 4 additions & 4 deletions static/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@

VSL is a V library to develop Artificial Intelligence and High-Performance Scientific Computations.

| | | | |
| :-----------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-------------------------------------------------------------------: | :--------------------------------------------------------------------------: |
| ![sierpinski_triangle](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle.png) | ![mandelbrot_blue_red_black](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_blue_red_black.png) | ![julia](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia.png) | ![mandelbrot_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_basic.png) |
| ![mandelbrot_pseudo_random_colors](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_pseudo_random_colors.png) | ![sierpinski_triangle2](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle2.png) | ![julia_set](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_set.png) | ![julia_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_basic.png) |
| | | | |
| :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------: |
| ![sierpinski_triangle](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle.png) | ![mandelbrot_blue_red_black](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_blue_red_black.png) | ![julia](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia.png) | ![mandelbrot_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_basic.png) |
| ![mandelbrot_pseudo_random_colors](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_pseudo_random_colors.png) | ![sierpinski_triangle2](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle2.png) | ![julia_set](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_set.png) | ![julia_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_basic.png) |

## Docs

Expand Down
8 changes: 4 additions & 4 deletions vcl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ VCL is a high level way of writting programs with OpenCL using V.
These are highly opinionated OpenCL bindings for V. It tries to make GPU computing easy,
with some sugar abstraction, V's concurency and channels.

| | | | |
| :-----------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-------------------------------------------------------------------: | :--------------------------------------------------------------------------: |
| ![sierpinski_triangle](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle.png) | ![mandelbrot_blue_red_black](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_blue_red_black.png) | ![julia](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia.png) | ![mandelbrot_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_basic.png) |
| ![mandelbrot_pseudo_random_colors](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_pseudo_random_colors.png) | ![sierpinski_triangle2](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle2.png) | ![julia_set](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_set.png) | ![julia_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_basic.png) |
| | | | |
| :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------: |
| ![sierpinski_triangle](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle.png) | ![mandelbrot_blue_red_black](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_blue_red_black.png) | ![julia](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia.png) | ![mandelbrot_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_basic.png) |
| ![mandelbrot_pseudo_random_colors](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/mandelbrot_pseudo_random_colors.png) | ![sierpinski_triangle2](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/sierpinski_triangle2.png) | ![julia_set](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_set.png) | ![julia_basic](https://raw.githubusercontent.com/vlang/vsl/main/vcl/static/julia_basic.png) |

## Using custom OpenCL headers

Expand Down
Loading

0 comments on commit 8fbe201

Please sign in to comment.