diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 024ac9c21..4e75d7bfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ Thanks for your interest in DL4J. Our goal is to bring fast, open-source deep le ## Getting Started -Deeplearning4j's [open issues are here](https://github.com/deeplearning4j/deeplearning4j/issues). In time, we'll tag issues that would make a good first pull request for new contributors. An easy way to get started helping the project is to *file an issue*. You can do that on the Deeplearning4j issues page by clicking on the green button at the right. Issues can include bugs to fix, features to add, or documentation that looks outdated. +Deeplearning4j's [open issues are here](https://github.com/eclipse/deeplearning4j/issues). In time, we'll tag issues that would make a good first pull request for new contributors. An easy way to get started helping the project is to *file an issue*. You can do that on the Deeplearning4j issues page by clicking on the green button at the right. Issues can include bugs to fix, features to add, or documentation that looks outdated. Note that you will need to [build dl4j from source](https://deeplearning4j.org/docs/latest/deeplearning4j-build-from-source) diff --git a/README.md b/README.md index da04994d4..2b69f7981 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,17 @@ Welcome to the new monorepo of Deeplearning4j that contains the source code for all the following projects, in addition to the original repository of Deeplearning4j moved to [deeplearning4j](deeplearning4j): - * https://github.com/deeplearning4j/libnd4j - * https://github.com/deeplearning4j/nd4j - * https://github.com/deeplearning4j/datavec - * https://github.com/deeplearning4j/arbiter - * https://github.com/deeplearning4j/nd4s - * https://github.com/deeplearning4j/gym-java-client - * https://github.com/deeplearning4j/rl4j - * https://github.com/deeplearning4j/scalnet - * https://github.com/deeplearning4j/pydl4j - * https://github.com/deeplearning4j/jumpy - * https://github.com/deeplearning4j/pydatavec + * https://github.com/eclipse/deeplearning4j/tree/master/libnd4j + * https://github.com/eclipse/deeplearning4j/tree/master/nd4j + * https://github.com/eclipse/deeplearning4j/tree/master/datavec + * https://github.com/eclipse/deeplearning4j/tree/master/arbiter + * https://github.com/eclipse/deeplearning4j/tree/master/nd4s + * https://github.com/eclipse/deeplearning4j/tree/master/gym-java-client + * https://github.com/eclipse/deeplearning4j/tree/master/rl4j + * https://github.com/eclipse/deeplearning4j/tree/master/scalnet + * https://github.com/eclipse/deeplearning4j/tree/master/pydl4j + * https://github.com/eclipse/deeplearning4j/tree/master/jumpy + * https://github.com/eclipse/deeplearning4j/tree/master/pydatavec To build everything, we can use commands like @@ -30,6 +30,6 @@ mvn -B -V -U clean install -pl '!jumpy,!pydatavec,!pydl4j' -Dlibnd4j.platform=li An example of GPU "CC" or compute capability is 61 for Titan X Pascal. # Want some examples? -We have separate repository with various examples available: https://github.com/deeplearning4j/dl4j-examples +We have separate repository with various examples available: https://github.com/eclipse/deeplearning4j-examples -In the examples repo, you'll also find a tutorial series in Zeppelin: https://github.com/deeplearning4j/dl4j-examples/tree/master/tutorials +In the examples repo, you'll also find a tutorial series in Zeppelin: https://github.com/eclipse/deeplearning4j-examples/tree/master/tutorials diff --git a/arbiter/.github/CONTRIBUTING.md b/arbiter/.github/CONTRIBUTING.md deleted file mode 100644 index 17598f387..000000000 --- a/arbiter/.github/CONTRIBUTING.md +++ /dev/null @@ -1,15 +0,0 @@ -## Contribute - -1. Check for open issues, or open a new issue to start a discussion around a feature idea or a bug. -2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to contact us on Gitter using the link above. -3. Fork [the repository](https://github.com/deeplearning4j/Arbiter.git) on GitHub to start making your changes to the **master** branch (or branch off of it). -4. Write a test, which shows that the bug was fixed or that the feature works as expected. -5. Note the repository follows - the [Google Java style](https://google.github.io/styleguide/javaguide.html) - with two modifications: 120-char column wrap and 4-spaces indentation. You - can format your code to this format by typing `mvn formatter:format` in the - subproject you work on, by using the `contrib/formatter.xml` at the root of - the repository to configure the Eclipse formatter, or by [using the INtellij - plugin](https://github.com/HPI-Information-Systems/Metanome/wiki/Installing-the-google-styleguide-settings-in-intellij-and-eclipse). - -6. Send a pull request, and bug us on Gitter until it gets merged and published. diff --git a/arbiter/.github/ISSUE_TEMPLATE.md b/arbiter/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 9dd585d22..000000000 --- a/arbiter/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,19 +0,0 @@ -#### Issue Description - -Please describe your issue, along with: -- expected behavior -- encountered behavior - -#### Version Information - -Please indicate relevant versions, including, if relevant: - -* Deeplearning4j version -* platform information (OS, etc) -* CUDA version, if used -* NVIDIA driver version, if in use - -#### Contributing - -If you'd like to help us fix the issue by contributing some code, but would -like guidance or help in doing so, please mention it! diff --git a/arbiter/.github/PULL_REQUEST_TEMPLATE.md b/arbiter/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 1f92bacd6..000000000 --- a/arbiter/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## What changes were proposed in this pull request? - -(Please fill in changes proposed in this fix) - -## How was this patch tested? - -(Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests) - -Please review -https://github.com/deeplearning4j/deeplearning4j/blob/master/CONTRIBUTING.md before opening a pull request. diff --git a/datavec/.github/CONTRIBUTING.md b/datavec/.github/CONTRIBUTING.md deleted file mode 100644 index a4ea5dc58..000000000 --- a/datavec/.github/CONTRIBUTING.md +++ /dev/null @@ -1,15 +0,0 @@ -## Contribute - -1. Check for open issues, or open a new issue to start a discussion around a feature idea or a bug. -2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to contact us on Gitter using the link above. -3. Fork [the repository](https://github.com/deeplearning4j/DataVec.git) on GitHub to start making your changes to the **master** branch (or branch off of it). -4. Write a test, which shows that the bug was fixed or that the feature works as expected. -5. Note the repository follows - the [Google Java style](https://google.github.io/styleguide/javaguide.html) - with two modifications: 120-char column wrap and 4-spaces indentation. You - can format your code to this format by typing `mvn formatter:format` in the - subproject you work on, by using the `contrib/formatter.xml` at the root of - the repository to configure the Eclipse formatter, or by [using the INtellij - plugin](https://github.com/HPI-Information-Systems/Metanome/wiki/Installing-the-google-styleguide-settings-in-intellij-and-eclipse). - -6. Send a pull request, and bug us on Gitter until it gets merged and published. diff --git a/datavec/.github/ISSUE_TEMPLATE.md b/datavec/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 9dd585d22..000000000 --- a/datavec/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,19 +0,0 @@ -#### Issue Description - -Please describe your issue, along with: -- expected behavior -- encountered behavior - -#### Version Information - -Please indicate relevant versions, including, if relevant: - -* Deeplearning4j version -* platform information (OS, etc) -* CUDA version, if used -* NVIDIA driver version, if in use - -#### Contributing - -If you'd like to help us fix the issue by contributing some code, but would -like guidance or help in doing so, please mention it! diff --git a/datavec/.github/PULL_REQUEST_TEMPLATE.md b/datavec/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 1f92bacd6..000000000 --- a/datavec/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## What changes were proposed in this pull request? - -(Please fill in changes proposed in this fix) - -## How was this patch tested? - -(Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests) - -Please review -https://github.com/deeplearning4j/deeplearning4j/blob/master/CONTRIBUTING.md before opening a pull request. diff --git a/datavec/README.md b/datavec/README.md index 7188db359..e631d7510 100644 --- a/datavec/README.md +++ b/datavec/README.md @@ -32,7 +32,7 @@ static data and for sequences (time series). Such operations can be executed on Apart from obviously providing readers for classic data formats, DataVec also provides an interface. So if you wanted to ingest specific custom data, you wouldn't have to build the whole pipeline. You would just have to write the very first step. For example, if you describe through the API how your data fits into a common format that complies with the interface, DataVec -would return a list of Writables for each record. You'll find more detail on the API in the corresponding [module](https://github.com/deeplearning4j/DataVec/tree/master/datavec-api). +would return a list of Writables for each record. You'll find more detail on the API in the corresponding [module](https://github.com/eclipse/deeplearning4j/tree/master/datavec/datavec-api). Another thing you can do with DataVec is data cleaning. Instead of having clean, ready-to-go data, let's say you start with data in different forms or from different sources. You might need to do sampling, filtering, or several incredibly messy ETL tasks needed to prepare data in the real world. DataVec offers filters and transformations that help with curating, preparing and massaging your data. It leverages Apache Spark to do this at scale. @@ -51,7 +51,7 @@ to be locked into a single tool, and using [Apache Flink](https://flink.apache.o ## Examples Examples for using DataVec are available -here: [https://github.com/deeplearning4j/dl4j-examples](https://github.com/deeplearning4j/dl4j-examples) +here: [https://github.com/eclipse/deeplearning4j-examples](https://github.com/eclipse/deeplearning4j-examples) --- @@ -91,7 +91,7 @@ It's useful to know which maintainers to contact to get information on a particu 1. Check for open issues, or open a new issue to start a discussion around a feature idea or a bug. 2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to contact us on Gitter using the link above. -3. Fork [the repository](https://github.com/deeplearning4j/datavec.git) on GitHub to start making your changes. +3. Fork [the repository](https://github.com/eclipse/deeplearning4j.git) on GitHub to start making your changes. 4. Write a test, which shows that the bug was fixed or that the feature works as expected. 5. Note the repository follows the [Google Java style](https://google.github.io/styleguide/javaguide.html) with two modifications: 120-char column wrap and 4-spaces indentation. You can format your code to this format by typing `mvn diff --git a/deeplearning4j/.github/CONTRIBUTING.md b/deeplearning4j/.github/CONTRIBUTING.md deleted file mode 120000 index 44fcc6343..000000000 --- a/deeplearning4j/.github/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -../CONTRIBUTING.md \ No newline at end of file diff --git a/deeplearning4j/.github/ISSUE_TEMPLATE.md b/deeplearning4j/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 95d46fee4..000000000 --- a/deeplearning4j/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,19 +0,0 @@ -#### Issue Description - -Please describe our issue, along with: -- expected behavior -- encountered behavior - -#### Version Information - -Please indicate relevant versions, including, if relevant: - -* Deeplearning4j version -* platform information (OS, etc) -* CUDA version, if used -* NVIDIA driver version, if in use - -#### Contributing - -If you'd like to help us fix the issue by contributing some code, but would -like guidance or help in doing so, please mention it! diff --git a/deeplearning4j/.github/PULL_REQUEST_TEMPLATE.md b/deeplearning4j/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 44316b06f..000000000 --- a/deeplearning4j/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -## What changes were proposed in this pull request? - -(Please fill in changes proposed in this fix) - -## How was this patch tested? - -(Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests) - -## Quick checklist - -The following checklist helps ensure your PR is complete: - -- [ ] Reviewed the [Contributing Guidelines](https://github.com/deeplearning4j/deeplearning4j/blob/master/CONTRIBUTING.md) and followed the steps within. -- [ ] Created tests for any significant new code additions. -- [ ] Relevant tests for your changes are passing. -- [ ] Ran mvn formatter:format (see [formatter instructions](http://code.revelc.net/formatter-maven-plugin/examples.html#Setting_Source_Files) for targeting your specific files). diff --git a/deeplearning4j/.github/lock.yml b/deeplearning4j/.github/lock.yml deleted file mode 100644 index cdf578845..000000000 --- a/deeplearning4j/.github/lock.yml +++ /dev/null @@ -1,28 +0,0 @@ -# Configuration for lock-threads - https://github.com/dessant/lock-threads - -# Number of days of inactivity before a closed issue or pull request is locked -daysUntilLock: 45 - -# Issues and pull requests with these labels will not be locked. Set to `[]` to disable -exemptLabels: [] - -# Label to add before locking, such as `outdated`. Set to `false` to disable -lockLabel: Outdated - -# Comment to post before locking. Set to `false` to disable -lockComment: > - This thread has been automatically locked since there has not been - any recent activity after it was closed. Please open a new issue for - related bugs. - -# Limit to only `issues` or `pulls` -# only: issues - -# Optionally, specify configuration settings just for `issues` or `pulls` -# issues: -# exemptLabels: -# - help-wanted -# lockLabel: outdated - -# pulls: -# daysUntilLock: 30 \ No newline at end of file diff --git a/deeplearning4j/GITTER_GUIDELINES.md b/deeplearning4j/GITTER_GUIDELINES.md index a8a43964a..fdb5609a8 100644 --- a/deeplearning4j/GITTER_GUIDELINES.md +++ b/deeplearning4j/GITTER_GUIDELINES.md @@ -7,14 +7,14 @@ Welcome, stranger. You probably just joined a Gitter channel for Deeplearning4j. 3. We're doing our best to improve the documentation, but it's not perfect. We welcome ideas about how to improve it! Writing good docs is our responsibility; reading them is yours. Please consult the docs before you post in the channel. A little effort from you will earn a lot of respect from us. (DL4J is backed by a startup, Skymind, and we are serving customers as well as the open-source community, which feels like a lot sometimes.) * User guide: [https://deeplearning4j.org/docs/latest/](https://deeplearning4j.org/docs/latest/) * API: [https://deeplearning4j.org/api/latest/](https://deeplearning4j.org/api/latest/) -4. We welcome new contributors! Once you get familiar with the libs, if you see how our code can be improved, please file an issue or consider sending us a pull request with the new feature. [https://github.com/deeplearning4j/deeplearning4j/issues](https://github.com/deeplearning4j/deeplearning4j/issues) +4. We welcome new contributors! Once you get familiar with the libs, if you see how our code can be improved, please file an issue or consider sending us a pull request with the new feature. [https://github.com/eclipse/deeplearning4j/issues](https://github.com/eclipse/deeplearning4j/issues) Many of the questions asked on the Deeplearning4j Gitter support channel have been answered already in our documentation or can be easily Googled. To respect the Skymind team's time, Deeplearning4j users are kindly asked to remember a few things: 1. Please use Google before you ask a question. The Deeplearning4j Gitter channel should not be used as a human-enhanced search engine. (We promise that you'll end up with a better open-source framework if you only ask us the hard questions...) Please remember that DL4J Gitter channels are devoted to DL4J and other Skymind libraries specifically. We can't help with other frameworks or tools, which have their own docs and communities. 2. If you don't receive an immediate response, please post again and flag your question with the Gitter ID of one of the people in the channel answering questions. If you do receive a response and link, please spend some time reading and trying to understand the response and additional resources before you ask the same question again. 3. To answer questions, we need to know about your OS, Java version, Maven version and we may even need to see your code and stacktrace. When we ask for code, please send us a gist using https://gist.github.com/. If you can't give us code, in many cases we can't help you. (It's also a great sign of commitment on your part!) -4. We're not perfect, and neither is our documentation. If you find ways for us to improve, please open an issue [here](https://github.com/deeplearning4j/deeplearning4j/issues) or email us at help@skymind.io and let us know what we need to fix. +4. We're not perfect, and neither is our documentation. If you find ways for us to improve, please open an issue [here](https://github.com/eclipse/deeplearning4j/issues) or email us at help@skymind.io and let us know what we need to fix. 5. Neural nets aren't magic. They are inherently hard to tune. We get many questions from beginners on how to tune neural nets. If you must post a question related to tuning, please post to: https://gitter.im/deeplearning4j/deeplearning4j/tuninghelp ### Guidelines for Help with Neural Network Tuning: @@ -26,7 +26,7 @@ Providing help for tuning neural networks can be quite time consuming for the de 1. Before posting a question, please first read both [https://deeplearning4j.org/docs/latest/deeplearning4j-troubleshooting-training](https://deeplearning4j.org/docs/latest/deeplearning4j-troubleshooting-training) and [https://deeplearning4j.org/docs/latest/deeplearning4j-nn-visualization](https://deeplearning4j.org/docs/latest/deeplearning4j-nn-visualization). You may also find an answer to your question on one of the other pages: [https://deeplearning4j.org/docs/latest/](https://deeplearning4j.org/docs/latest/) 2. We generally won't answer questions that can be easily answered by searching Google or reading something like Andrej Karpathy's Stanford course on convolutional networks [http://cs231n.github.io/](http://cs231n.github.io/) or Ian Goodfellow and Yoshua Bengio's deep learning book [http://www.deeplearningbook.org/](http://www.deeplearningbook.org/) 3. For some questions/issues, it may not be possible to provide a short/simple answer to your question. In these cases, we might decide to answer your question by improving our documentation, instead of answering your question directly in Gitter. Please understand that improving our documentation helps *everyone* and is a better use of the team's time than answering one-off questions. -4. You should generally feel free to open issues ([https://github.com/deeplearning4j/deeplearning4j/issues](https://github.com/deeplearning4j/deeplearning4j/issues)) if you feel our documentation (troubleshooting/tuning) is lacking or doesn't answer common questions. +4. You should generally feel free to open issues ([https://github.com/eclipse/deeplearning4j/issues](https://github.com/eclipse/deeplearning4j/issues)) if you feel our documentation (troubleshooting/tuning) is lacking or doesn't answer common questions. 5. Upon entering the room, please do more than say "hi". Information-rich questions and comments are appreciated. Please keep the content relevant. Please note the below channels for different parts of the conversation. * Contributors/building from source: [https://gitter.im/deeplearning4j/deeplearning4j/earlyadopters](https://gitter.im/deeplearning4j/deeplearning4j/earlyadopters) diff --git a/deeplearning4j/README.md b/deeplearning4j/README.md index f7892cb8f..517cc820e 100755 --- a/deeplearning4j/README.md +++ b/deeplearning4j/README.md @@ -38,7 +38,7 @@ To get started using Deeplearning4j, please go to our [Quickstart](https://deepl --- ## Documentation -Documentation is available at [deeplearning4j.org](https://deeplearning4j.org/overview) and [JavaDocs](https://deeplearning4j.org/api/latest/). Open-source contributors can help us improve our documentation for Deeplearning4j by sending pull requests for the DL4J website [here](https://github.com/deeplearning4j/deeplearning4j/tree/gh-pages) and ND4J [here](https://github.com/deeplearning4j/nd4j/tree/gh-pages). +Documentation is available at [deeplearning4j.org](https://deeplearning4j.org/overview) and [JavaDocs](https://deeplearning4j.org/api/latest/). Open-source contributors can help us improve our documentation for Deeplearning4j by sending pull requests for the DL4J website [here](https://github.com/eclipse/deeplearning4j-docs) ## Support @@ -52,7 +52,7 @@ To install Deeplearning4J, see our [Quickstart](https://deeplearning4j.org/docs/ Search Maven Central for [deeplearning4j](https://search.maven.org/#search%7Cga%7C1%7Cdeeplearning4j) to get a list of dependencies. -Add the dependency information to your `pom.xml` file. **We highly recommend downloading via Maven unless you plan to help us develop DL4J.** An easy way to get up-to-date dependencies is to use the ones listed in our [dl4j-examples POM](https://github.com/deeplearning4j/dl4j-examples/blob/master/pom.xml). +Add the dependency information to your `pom.xml` file. **We highly recommend downloading via Maven unless you plan to help us develop DL4J.** An easy way to get up-to-date dependencies is to use the ones listed in our [dl4j-examples POM](https://github.com/eclipse/deeplearning4j-examples/blob/master/pom.xml).