Skip to content

Commit

Permalink
adjust readme and add clang tidy/format
Browse files Browse the repository at this point in the history
  • Loading branch information
samayala22 committed Feb 20, 2024
1 parent 096b8ea commit 6817bac
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
BasedOnStyle: LLVM
IndentWidth: 4
AccessModifierOffset: -4
11 changes: 11 additions & 0 deletions .clang-tidy
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Checks: '-*,clang-diagnostic-*,misc-*,performance-*,clang-analyzer-*,bugprone-*'
CheckOptions:
- { key: readability-identifier-naming.NamespaceCase, value: lower_case }
- { key: readability-identifier-naming.ClassCase, value: CamelCase }
- { key: readability-identifier-naming.PrivateMemberPrefix, value: m_ }
- { key: readability-identifier-naming.StructCase, value: CamelCase }
- { key: readability-identifier-naming.FunctionCase, value: lower_case }
- { key: readability-identifier-naming.VariableCase, value: lower_case }
- { key: readability-identifier-naming.MemberCase, value: lower_case }
- { key: readability-identifier-naming.GlobalConstantCase, value: UPPER_CASE }
- { key: readability-simplify-boolean-expr, value: true }
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,22 @@

# Backends

- [ ] Generic (already implemented but mixed up with AVX2 backend)
- [X] AVX2 (going to be replaced by ISPC)
- [X] CUDA (wip, some kernels are missing)
- [ ] SYCL ? HIP ? Vulkan ?
- [X] ISPC
- [X] CUDA

# Maintainability

- [X] Clangd
- [ ] Clang-Tidy
- [X] Clang-Format
- [X] Clang-Tidy
- [X] Testing framework (via `xmake test`)
- [X] Compilation CI
- [ ] Performance regression CI
- [ ] Documented code (doxygen style)

## Build and run

Requirements:
- Windows (MSVC compiler) or Linux (GCC or Clang)
- CPU that supports AVX2
- [xmake](https://xmake.io/#/) build system
- For Windows, the [installer](https://github.com/xmake-io/xmake/releases) is recommended
- For Linux, run `curl -fsSL https://xmake.io/shget.text | bash`
Expand Down
5 changes: 2 additions & 3 deletions vlm/backends/cuda/src/vlm_backend_cuda.cu
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,11 @@ public:
cudaStream_t stream() {return(m_stream);}
cublasHandle_t cublas() {return(m_cublas);}

protected:
private:
cusolverDnHandle_t m_cusolver = nullptr;
cudaStream_t m_stream = nullptr;
cublasHandle_t m_cublas = nullptr;

private:

CtxManager() = default;
~CtxManager() = default;
};
Expand Down

0 comments on commit 6817bac

Please sign in to comment.