Merge branch 'main' into manukyutai-patch-1

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,79 @@
+name: Bug Report
+description: You found a bug.
+labels: ["bug", "triage"]
+body:
+  - type: dropdown
+    id: backend
+    attributes:
+      label: Backend impacted
+      description: Which backend is concerned with your bug report?
+      options:
+        - The PyTorch implementation
+        - The MLX implementation
+        - The Rust implementation
+        - Other / All
+      default: 0
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      description: What is your operating system?
+      options:
+        - Linux
+        - Mac OS X
+        - Windows (unsupported)
+      default: 0
+    validations:
+      required: true
+  - type: dropdown
+    id: hardware
+    attributes:
+      label: Hardware
+      description: What hardware are you using?
+      options:
+        - CPU
+        - GPU with CUDA
+        - Metal with MLX
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Provide a detailed description of your bug.
+      placeholder: 
+      value: 
+    validations:
+      required: true
+  - type: textarea
+    id: more_info
+    attributes:
+      label: Extra information
+      description: Please provide any other relevant information, such as log extracts, code etc.
+      placeholder: 
+      value: 
+    validations:
+      required: true
+  - type: textarea
+    id: env
+    attributes:
+      label: Environment
+      description: Please provide any other relevant information, such as log extracts, code etc.
+      placeholder: 
+      value: |
+          Fill in the following information on your system.
+          - Operating system version:
+
+          If the backend impacted is PyTorch:
+          - Python version:
+          - PyTorch version:
+          - CUDA version (run `python -c 'import torch;  print(torch.version.cuda)'`):
+          - GPU model and memory:
+            
+          If the backend is MLX:
+          - Mac model:
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,36 @@
+name: Question
+description: You have a question about Moshi/Mimi, this codebase.
+labels: ["question", "triage"]
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Due diligence
+      description: Have you searched the existing issues / Google / asked ChatGPT?
+      options:
+        - label: I have done my due diligence in trying to find the answer myself.
+          required: true
+
+  - type: dropdown
+    id: backend
+    attributes:
+      label: Topic
+      description: What is your question about?
+      options:
+        - The paper
+        - The PyTorch implementation
+        - The MLX implementation
+        - The Rust implementation
+        - Other / All
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What is your question?
+      placeholder: Your question. Please make sure this is directly related to our codebase. We will not provide support for installing PyTorch, CUDA, Rust etc.
+      value: 
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## Checklist
+
+- [ ] Read CONTRIBUTING.md, and accept the CLA by including the provided snippet. We will not accept PR without this.
+- [ ] Run pre-commit hook.
+- [ ] If you changed Rust code, run `cargo check`, `cargo clippy`, `cargo test`.
+
+## PR Description
+
+<!-- Description for the PR -->

.github/actions/moshi_build/action.yml

@@ -22,6 +22,6 @@ runs:
   - name: Setup env
     shell: bash
     run: |
-      .  env/bin/activate
+      source  env/bin/activate || ( echo "FAILED" && ls && ls env && exit 1)
       pre-commit install
       pip install -e './moshi[dev]'

CONTRIBUTING.md

@@ -4,20 +4,47 @@
 
 Moshi is the implementation of a research paper.
 Therefore, we do not plan on accepting many pull requests for new features.
-We certainly welcome them for bug fixes.
+However, we certainly welcome them for bug fixes.
 
 1. Fork the repo and create your branch from `main`.
-2. If you've changed APIs, update the documentation.
+2. If you have changed APIs, update the documentation accordingly.
 3. Ensure pre-commit hooks pass properly, in particular the linting and typing.
-4. Accept the Contributor License Agreement (see after).
+4. When changing the Rust code, run `cargo check`, `cargo clippy`, `cargo test`.
+5. Accept the Contributor License Agreement (see after).
 
-Note that in general we will not accept refactoring of the code.
+Note that in general, we will not accept refactoring of the code.
 
 
 ## Contributor License Agreement ("CLA")
 
-In order to accept your pull request, we need you to submit a Contributtor License Agreement.
-As this CLA is not ready yet, we will delay acceptance of your PR.
+In order to accept your pull request, we need you to submit a Contributor License Agreement.
+
+If you agree with the full CLA provided in the next paragraph, copy the following statement in your PR, changing your Github Handle:
+
+> I, {your GitHub handle}, confirm that I have read and understood the terms of the CLA of Kyutai-labs, as outlined in the repository's CONTRIBUTING.md, and I agree to be bound by these terms.
+
+The full CLA is provided as follows:
+
+> I, {your GitHub handle}, hereby grant to Kyutai-labs a perpetual, worldwide, non-exclusive, royalty-free,
+> irrevocable license to use, modify, distribute, and sublicense my Contributions.
+
+> I understand and accept that Contributions are limited to modifications, improvements, or changes
+> to the project’s source code submitted via pull requests. I accept that Kyutai-labs has full discretion to
+> review, accept, reject, or request changes to any Contributions I submit, and that submitting
+> a pull request does not guarantee its inclusion in the project.
+
+> By submitting a Contribution, I grant Kyutai-labs a perpetual, worldwide license to use, modify,
+> reproduce, distribute, and create derivative works based on my Contributions.
+> I also agree to assign all patent rights for any inventions or improvements that arise from my Contributions,
+> giving the Kyutai-labs full rights to file for and enforce patents.
+> I understand that the Kyutai-labs may commercialize, relicense, or exploit the project and my Contributions without further notice or obligation to me.
+> I confirm that my Contributions are original and that I have the legal right to grant this license.
+> If my Contributions include third-party materials, I will ensure that I have the necessary permissions
+> and will disclose this information. I accept that once my Contributions are integrated, they may be altered or removed at the Kyutai-labs’s discretion.
+
+> I acknowledge that I am making these Contributions voluntarily and will not receive any compensation.
+> Furthermore, I understand that all Contributions, including mine, are provided on an "as-is" basis, with no warranties.
+> By submitting a pull request, I agree to be bound by these terms.
 
 ## Issues