Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
makr11st committed Mar 2, 2023
0 parents commit 3ebe2df
Show file tree
Hide file tree
Showing 17 changed files with 2,427 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**/target
**/target-linux
Cargo.lock
docker-build
131 changes: 131 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# `tf-layers` Community Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected] or https://crowdstrike.ethicspoint.com/.

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

[![Twitter URL](https://img.shields.io/twitter/url?label=Follow%20%40CrowdStrike&style=social&url=https%3A%2F%2Ftwitter.com%2FCrowdStrike)](https://twitter.com/CrowdStrike)
73 changes: 73 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributing to this repository

## Getting started

_Welcome!_ We're excited you want to take part in the `tf-layers` community!

Please review this document for details regarding getting started with your first contribution, packages you'll need to install as a developer, and our Pull Request process. If you have any questions, please let us know by
posting your question as an [issue](https://github.com/CrowdStrike/tf-layers/issues/new).

### Before you begin

* Have you read the [Code of Conduct](CODE_OF_CONDUCT.md)? The Code of Conduct helps us establish community norms and how they'll be enforced.

### Table of Contents

* [How you can contribute](#how-you-can-contribute)
* [Bug reporting](#bug-reporting-and-questions-are-handled-using-githubs-issues)
* [Pull Requests](#pull-requests)
* [Contributor dependencies](#additional-contributor-package-requirements)
* [Unit testing](#unit-testing--code-coverage)
* [Linting](#linting)
* [Breaking changes](#breaking-changes)
* [Branch targeting](#branch-targeting)
* [Suggestions](#suggestions)

## How you can contribute

* See something? Say something! Submit a [bug report](https://github.com/CrowdStrike/tf-layers/issues) to let the community know what you've experienced or found. Bonus points if you suggest possible fixes or what you feel may resolve the issue. For example: "_Attempted to use the XZY API class but it errored out. Could a more descriptive error code be returned?_"
* Submit a [Pull Request](#pull-requests)

### Bug reporting and questions are handled using GitHub's issues

We use GitHub issues to track bugs. Report a bug by opening a [new issue](https://github.com/CrowdStrike/tf-layers/issues).

## Pull Requests

### All contributions will be submitted under the MIT license

When you submit code changes, your submissions are understood to be under the same MIT [license](LICENSE) that covers the project.
If this is a concern, contact the maintainers before contributing.

### Breaking changes

In an effort to maintain backwards compatibility, we thoroughly unit test every Pull Request for any issues. These unit tests are intended to catch general programmatic errors, possible vulnerabilities (via bandit) and _potential breaking changes_.

> If you have to adjust a unit test locally in order to produce passing results, there is a possibility you are working with a potential breaking change.
Please fully document changes to unit tests within your Pull Request. If you did not specify "Breaking Change" on the punch list in the description, and the change is identified as possibly breaking, this may delay or prevent approval of your PR.

### Versioning

We use [SemVer](https://semver.org/) as our versioning scheme. (Example: _2.1.4_)

### Pull Request template

Please use the pull request template provided, making sure the following details are included in your request:

* Is this a breaking change?
* Are all new or changed code paths covered by unit testing?
* A complete listing of issues addressed or closed with this change.
* A complete listing of any enhancements provided by this change.
* Any usage details developers may need to make use of this new functionality.
* Does additional documentation need to be developed beyond what is listed in your Pull Request?
* Any other salient points of interest.

### Approval / Merging

All Pull Requests must be approved by at least one maintainer. Once approved, a maintainer will perform the merge and execute any backend
processes related to package deployment. At this time, contributors _do not_ have the ability to merge to the `main` branch.

## Suggestions

If you have suggestions on how this process could be improved, please let us know by [posting an issue](https://github.com/CrowdStrike/tf-layers/issues).
21 changes: 21 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[package]
name = "tensorflow-layers"
version = "0.3.2"
authors = ["Crowdstrike DSCI <[email protected]>"]
edition = "2021"
description = "Pure Rust implementation of layers used in Tensorflow models"
license = "MIT"
include = ["Cargo.toml", "README.md", "benches/*", "src/*"]

[dependencies]
ndarray = { version = "0.15.6", features = ["serde-1"] }
serde = { version = "1.0.147", features = ["derive"] }
num-traits = "0.2.15"

[dev-dependencies]
criterion = "0.4.0"
lazy_static = "1.4.0"

[[bench]]
name = "benchmarks"
harness = false
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MIT License

Copyright (c) 2022 Crowdstrike

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Tensorflow Layers

This is an auxilary crate for tf2rust which provides Rust native implementations for some of the Tensorflow models layers.

## Building

## Testing

## Getting Help

`tf-layers` is an open source project, not a CrowdStrike product. As such it carries no formal support, expressed or implied.

If you encounter any issues while using `tf-layers`, you can create an issue on our Github repo for bugs, enhancements, or other requests.
49 changes: 49 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[![Twitter URL](https://img.shields.io/twitter/url?label=Follow%20%40CrowdStrike&style=social&url=https%3A%2F%2Ftwitter.com%2FCrowdStrike)](https://twitter.com/CrowdStrike)

![GitHub top language](https://img.shields.io/github/languages/top/crowdstrike/falconpy?logo=python&logoColor=white)
![GitHub issues](https://img.shields.io/github/issues-raw/crowdstrike/falconpy?logo=github)
![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/crowdstrike/falconpy?color=green&logo=github)

# Security Policy

This document outlines security policy and procedures for the CrowdStrike `tf-layers` project.

* [Supported versions](#supported-versions)
* [Reporting a potential security vulnerability](#reporting-a-potential-security-vulnerability)
* [Disclosure and Mitigation Process](#disclosure-and-mitigation-process)

## Supported versions

When discovered, we release security vulnerability patches for the most recent release at an accelerated cadence.

## Reporting a potential security vulnerability

We have multiple avenues to receive security-related vulnerability reports.

Please report suspected security vulnerabilities by:

* Submitting a [bug](https://github.com/CrowdStrike/tf-layers/issues/new?assignees=&labels=bug+%3Abug%3A&template=bug_report.md&title=%5B+BUG+%5D+...).
* Starting a new [discussion](https://github.com/CrowdStrike/tf-layers/discussions).
* Submitting a [pull request](https://github.com/CrowdStrike/tf-layers/pulls) to potentially resolve the issue. (New contributors: please review the content located [here](https://github.com/CrowdStrike/tf-layers/blob/main/CONTRIBUTING.md).)
* Sending an email to __[email protected]__.

## Disclosure and mitigation process

Upon receiving a security bug report, the issue will be assigned to one of the project maintainers. This person will coordinate the related fix and release
process, involving the following steps:

* Communicate with you to confirm we have received the report and provide you with a status update.

* You should receive this message within 48 - 72 business hours.

* Confirmation of the issue and a determination of affected versions.
* An audit of the codebase to find any potentially similar problems.
* Preparation of patches for all releases still under maintenance.

* These patches will be submitted as a separate pull request and contain a version update.
* This pull request will be flagged as a security fix.
* Once merged, and after post-merge unit testing has been completed, the patch will be immediately published to both PyPI repositories.

## Comments

If you have suggestions on how this process could be improved, please let us know by [starting a new discussion](https://github.com/CrowdStrike/tf-layers/discussions).
Loading

0 comments on commit 3ebe2df

Please sign in to comment.